Mermaid: Generation of diagrams like flowcharts or sequence diagrams from text
Published on: 2025-06-20 14:06:46
Mermaid
Generate diagrams from markdown-like text.
Live Editor!
đ Documentation | đ Getting Started | đ CDN | đ Join Us
įŽäŊ䏿
Try Live Editor previews of future releases: Develop | Next
đ Mermaid was nominated and won the JS Open Source Awards (2019) in the category "The most exciting use of technology"!!!
Thanks to all involved, people committing pull requests, people answering questions! đ
Table of content
About
Mermaid is a JavaScript-based diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams. The main purpose of Mermaid is to help documentation catch up with development.
Doc-Rot is a Catch-22 that Mermaid helps to solve.
Diagramming and documentation costs precious developer time and gets outdated quickly. But not having diagrams or docs ruins productivity and hurts organizational learning.
Mermaid addresses this problem by enabling users to create easily modifiable diagrams. It can also be made
... Read full article.