https://github.com/perryvw/mermaid-markdown-docs
A documentation framework allowing you to easily make a documentation website from markdown files, with mermaid diagrams and search built-in!
https://github.com/perryvw/mermaid-markdown-docs
documentation esbuild lunr markdown mermaid search
Last synced: 6 months ago
JSON representation
A documentation framework allowing you to easily make a documentation website from markdown files, with mermaid diagrams and search built-in!
- Host: GitHub
- URL: https://github.com/perryvw/mermaid-markdown-docs
- Owner: Perryvw
- Created: 2023-02-05T21:23:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-19T17:58:12.000Z (about 2 years ago)
- Last Synced: 2025-02-12T02:11:39.127Z (8 months ago)
- Topics: documentation, esbuild, lunr, markdown, mermaid, search
- Language: TypeScript
- Homepage: https://perryvw.github.io/mermaid-markdown-docs/
- Size: 481 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mermaid-Markdown-Docs
Mermaid-Markdown-Docs is a framework to easily create documentation websites from markdown files, with minimal setup.
Live demo: [Mermaid-Markdown-Docs documentation](https://perryvw.github.io/mermaid-markdown-docs/)
## Built-in features:
- Create a documentation website entirely from markdown files
- Built-in support for [Mermaid diagrams](https://mermaid.js.org/)
- Built-in search functionality using [Lunr.js](https://lunrjs.com/)
- Development server with automatic reloading when changes are detected
- Fast build speeds thanks to running on esbuild
- Independent output bundle, it is just html and js, it can run anywhere!
# Installation
The package `mermaid-markdown-docs` can be installed from npm using the following command:
```
npm i -D mermaid-markdown-docs
```
# Documentation
Find our documentation - generated using mermaid-markdown-docs from this repository - here: [Mermaid-Markdown-Docs documentation](https://perryvw.github.io/mermaid-markdown-docs/)