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

Built-in features:

• Create a documentation website entirely from markdown files
• Built-in support for Mermaid diagrams
• Built-in search functionality using Lunr.js
• 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