zero-md-docs
Advanced tools
Readme
Instantly publish markdown from your Github docs folder
Elegantly leverage your Github docs/ directory to host a Github Pages website. This
project builds and places index.html files into docs/** folders, turning them into
a progressive web app that dynamically loads and displays each readme.md file when
accessed.
This gives a clean experience for your users: users can view nicely formatted readme.md
markdown from both Github UI and from your public-facing site; changes to markdown is
reflected immediately without a rebuild; and you avoid polluting your git history with
tons of build commits.
Features:
Todos:
tailwindcss first-classinit, build and preview commands$ npm i -g zero-md-docs
Write readme.md files into your docs/ directory like so:
.
└── docs/
├── foo/
│ └── readme.md
├── bar/
│ └── readme.md
├── menu-item/
│ └── readme.md
└── readme.md
Initialise a zmdocs.config.cjs file in project root with configs like so:
module.exports = {
head: '', // HTML string added into start of `<head>`
header: '', // HTML string added to start of `<body>`
footer: '', // HTML string added to end of `<body>`
links: [
{ title: 'Overview', href: '/repo/', dir: 'docs' } // Array of navigation links
{ title: 'Foo', href: '/repo/foo/', dir: 'docs/foo' }
{ title: 'Bar', href: '/repo/bar/', dir: 'docs/bar' }
{ title: 'Menu Item', href: '/repo/menu-item/', dir: 'docs/menu-item' }
],
_template: 'default', // Use the `default` template
_title: '' // Dummy placeholder (required)
}
$ zero-md-docs
From your Github repo page, go to Setting -> Pages -> Source -> Select /docs, then Save.
That's it! Your site is now available at https://<username>.github.io/<repo>/.
Install static-sitemap-cli.
$ npm i -g static-sitemap-cli
Then generate the sitemaps with:
$ sscli -b https://<username>.github.io/<repo> -r docs --slash
Just copy your favicon.ico file into the /docs folder.
Most modern analytics platforms support Single-Page Apps by automatically hooking into the
History API and listening for changes - in which case a pageview event is sent.
Add the HTML snippet into <head> like so:
zmdocs.config.cjs
module.exports = {
head: `<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-XXXXXXXXXX"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-XXXXXXXXXX');
</script>`,
header: '',
footer: '',
...
}
Development docs are a WIP but looking for theme contributions.
ISC
FAQs
Instantly publish markdown from your Github docs folder
The npm package zero-md-docs receives a total of 6 weekly downloads. As such, zero-md-docs popularity was classified as not popular.
We found that zero-md-docs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.