https://github.com/adamijak/md-doc
https://github.com/adamijak/md-doc
documentation documentation-generator documentation-tool github github-flavored-markdown markdown markdown-to-html marked marked-js markedjs mermaid mermaidjs
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/adamijak/md-doc
- Owner: adamijak
- License: mit
- Created: 2025-04-24T22:00:55.000Z (25 days ago)
- Default Branch: main
- Last Pushed: 2025-05-06T10:08:36.000Z (14 days ago)
- Last Synced: 2025-05-07T15:19:46.679Z (13 days ago)
- Topics: documentation, documentation-generator, documentation-tool, github, github-flavored-markdown, markdown, markdown-to-html, marked, marked-js, markedjs, mermaid, mermaidjs
- Language: HTML
- Homepage: https://adamijak.github.io/md-doc/
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# md-doc
## Quick-start
Download [md-doc.html](https://raw.githubusercontent.com/adamijak/md-doc/refs/heads/main/md-doc.html)
and edit the file in you favourite editor.
## About
md-doc is a tool for writing self-contained HTML documentation.
Its goal is to provide the documentation without additional compile step.
## Installation
md-doc only requires modern browser and internet connection for initial load.
You can continue working even offline since the browser caches the files.
## Documentation
See the [website](https://adamijak.github.io/md-doc/)