zero-md-docs
Advanced tools
Instantly publish markdown from Github docs folder
Elegantly leverage on your Github docs folder as a public-facing documentation website. Super easy to use, barely an inconvenience. Inspired by docsify.
Structure your docs/ folder like so:
.
└── docs/
├── readme.md # TOC (navigation menu)
├── index.html # Copy from template
├── home.md # ...Site pages
├── getting-started.md
└── config.md
...
└── any-other-page.md
index.htmlCopy and paste the following code into docs/index.html:
<!-- index.html -->
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<!-- Import module and stylesheet -->
<script type="module" src="https://cdn.jsdelivr.net/npm/zero-md-docs@1"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/zero-md-docs@1/dist/default.css" />
</head>
<body>
<!-- Declare `app` entry point -->
<div id="app"></div>
</body>
</html>
readme.mdCreate docs/readme.md containing a table of contents (or site links). This acts as the site
navigation menu.
<!-- readme.md -->
- [Home](home.md)
- [Getting Started](getting-started.md)
- [Configuration](config.md)
...
- [External Link](https://example.com/)
[!NOTE]
The first link is always the home page.
From your Github repo page, go to Setting > Pages > Source > Deploy from a branch, then select the
/docs folder.
░██████╗░█████╗░██╗░░░██╗███████╗██╗ ██╔════╝██╔══██╗██║░░░██║██╔════╝██║ ╚█████╗░███████║╚██╗░██╔╝█████╗░░██║ ░╚═══██╗██╔══██║░╚████╔╝░██╔══╝░░╚═╝ ██████╔╝██║░░██║░░╚██╔╝░░███████╗██╗ ╚═════╝░╚═╝░░╚═╝░░░╚═╝░░░╚══════╝╚═╝
...and voila - your site is now available at https://<user>.github.io/<repo>/.
ISC
FAQs
Instantly publish markdown from Github docs folder
The npm package zero-md-docs receives a total of 7 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 0 open source maintainers 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.
Research
Security News
The Socket Research Team has discovered six new malicious npm packages linked to North Korea’s Lazarus Group, designed to steal credentials and deploy backdoors.
Security News
Socket CEO Feross Aboukhadijeh discusses the open web, open source security, and how Socket tackles software supply chain attacks on The Pair Program podcast.
Security News
Opengrep continues building momentum with the alpha release of its Playground tool, demonstrating the project's rapid evolution just two months after its initial launch.