Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zerodevx/zero-md-docs
Instantly publish markdown from Github docs folder
https://github.com/zerodevx/zero-md-docs
api-documentation-tool markdown-to-html zero-md
Last synced: 12 days ago
JSON representation
Instantly publish markdown from Github docs folder
- Host: GitHub
- URL: https://github.com/zerodevx/zero-md-docs
- Owner: zerodevx
- License: isc
- Created: 2020-03-30T08:09:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-23T14:41:11.000Z (about 2 months ago)
- Last Synced: 2024-10-05T12:04:46.723Z (about 2 months ago)
- Topics: api-documentation-tool, markdown-to-html, zero-md
- Language: Svelte
- Homepage:
- Size: 556 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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`](https://docsify.js.org).
## Usage
Structure your `docs/` folder like so:
```text
.
└── 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`:
```html
```
### Add `readme.md`
Create `docs/readme.md` containing a table of contents (or site links). This acts as the site
navigation menu.
```text
- [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 `Settings -> Pages`, set `Source` to `Deploy from a branch`, and
set `Branch` to `/docs`...
```
░██████╗░█████╗░██╗░░░██╗███████╗██╗
██╔════╝██╔══██╗██║░░░██║██╔════╝██║
╚█████╗░███████║╚██╗░██╔╝█████╗░░██║
░╚═══██╗██╔══██║░╚████╔╝░██╔══╝░░╚═╝
██████╔╝██║░░██║░░╚██╔╝░░███████╗██╗
╚═════╝░╚═╝░░╚═╝░░░╚═╝░░░╚══════╝╚═╝
```
...and voila - your site is now available at `https://.github.io//`.
## License
ISC