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: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/adamijak/md-doc
- Owner: adamijak
- License: mit
- Created: 2025-04-24T22:00:55.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-19T12:43:37.000Z (about 1 year ago)
- Last Synced: 2025-05-19T12:45:24.442Z (about 1 year ago)
- Topics: documentation, documentation-generator, documentation-tool, github, github-flavored-markdown, markdown, markdown-to-html, marked, marked-js, markedjs, mermaid, mermaidjs
- Language: JavaScript
- 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
md-doc is a VSCode extension for Markdown compilation to self-contained HTML file.
It's main usage is for creation of design documents or documentaion.
## Quick-start
1. First download [md-doc](https://marketplace.visualstudio.com/items?itemName=adamijak.md-doc) VSCode extension.
2. Create `md-doc.json` configuration file.
```json
{
"title": "my-title",
"files": ["path-to-source-file.md"]
}
```
3. Start compilation using `Markdown Documentation: Start` command.
## Documentation
See the [website](https://adamijak.github.io/md-doc/)