Instantly publish markdown from Github
docs/folder
Elegantly leverage on your Github docs/ folder as a public-facing documentation website. Zero
build, zero config, zero effort - just drop markdown in docs/, get a site for free.
Demo: https://zerodevx.github.io/zero-md/
Structure your Github docs/ folder like so:
docs/
├── index.html # copy from template below
├── readme.md # nav menu (table of contents)
├── home.md # site pages...
├── getting-started.md
├── config.md
├── submenu.md
└── any-other-page.md
<!-- docs/index.html -->
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<!-- Import from CDN -->
<script type="module" src="https://cdn.jsdelivr.net/npm/zero-md@3?register"></script>
<script type="module" src="https://cdn.jsdelivr.net/npm/zero-md-docs@2/dist/index.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/zero-md-docs@2/dist/styles.css" />
</head>
<body>
<!-- Declare `app` entry point -->
<div id="app"></div>
</body>
</html>This is your site navigation - a plain markdown list of links.
<!-- docs/readme.md -->
- [Home](home.md)
- [Getting Started](getting-started.md)
- [Configuration](config.md)
- [Sub Menu](submenu.md)
- [External Link](https://example.com/)Note
The first link in the list is always treated as the home page.
In your repo, go to Settings -> Pages, set Source to Deploy from a branch, and set
Branch to /docs.
░██████╗░█████╗░██╗░░░██╗███████╗██╗
██╔════╝██╔══██╗██║░░░██║██╔════╝██║
╚█████╗░███████║╚██╗░██╔╝█████╗░░██║
░╚═══██╗██╔══██║░╚████╔╝░██╔══╝░░╚═╝
██████╔╝██║░░██║░░╚██╔╝░░███████╗██╗
╚═════╝░╚═╝░░╚═╝░░░╚═╝░░░╚══════╝╚═╝
...and voila - your site is now live at https://<user>.github.io/<repo>/.
Clone the repository and install dependencies.
git clone https://github.com/zerodevx/zero-md-docs.git
cd zero-md-docs
npm install
Run the dev server.
npm run dev
Build locally into dist/.
npm run build
Built with Svelte and zero-md, with Tailwind CSS and DaisyUI for styling.
Project is looking for theme contributions. If you'd like to help, open an issue and let's discuss.
Open a new issue or discussion - I'd be stoked to hear from you!
Standard Github contribution workflow applies.
ISC