zero-md-docs

Instantly publish markdown from Github docs folder

1.0.0-next.5
Source
npm

Version published: 8 months ago

Weekly downloads: 3; increased by50%

Maintainers: 1

Weekly downloads

Created: 3 years ago

Source

zero-md-docs

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.

Usage

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

Copy `index.html`

Copy 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>

Add `readme.md`

Create 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.

Publish with Github Pages

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>/.

License

ISC

Keywords

FAQs

What is zero-md-docs?

Is zero-md-docs popular?

Is zero-md-docs well maintained?

Package last updated on 28 Mar 2024

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.

Install