Table of contents
Mermaid JS is a Javascript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically. The syntax is easy and clear, and the output usually beautiful.
Mermaid Documentation Mermaid Online Editor
Integrations
About Mermaid is supported out-of-the-box by many applications, including:
- Jetbrains IDEs (IntelliJ, etc.) through the built-in Markdown Plugin (see diagrams);
- Visual Studio code;
- gitlab.com renders mermaid diagrams in and md file;
- GitHub, see their documentation on Creating Mermaid diagrams
- typora;
- …
See mermaid-js#integrations for a full list.