Mkdocs Mermaid2 Plugin
A Mermaid graphs plugin for mkdocs
Overview
Mkdocs-Mermaid2 is an MkDocs plugin that facilitates the rendering of Mermaid text descriptions into various types of diagrams such as flow charts, sequence diagrams, and pie charts. With support for different versions of the Mermaid library, this plugin simplifies the process of including dynamic diagrams in your MkDocs pages.
Features
- Diagram Renderings: Convert Mermaid text descriptions into graphical representations like flowcharts, class diagrams, state diagrams, and more.
- Version Compatibility: Works with versions of the Mermaid library above 10 and is also compatible with lower versions.
- Web Browser Rendering: Diagrams are rendered in the final HTML page by the web browser using the Mermaid javascript library.
- Material Theme Integration: Additional settings for the Material theme, ensuring diagrams adapt their colors to the theme palette.
Automatic
pip install mkdocs-mermaid2
Manual
- Clone the repository to a local directory.
- Install the package manually:
pip install /path/to/cloned/repository
- MkDocs
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
