Mermaid (software)
Diagramming and charting software
From Wikipedia, the free encyclopedia
Mermaid is an open-source JavaScript-based diagramming and charting software that generates diagrams from text-based descriptions.[1] Created by Knut Sveidqvist in 2014, the project originated from a need to simplify diagram creation in documentation workflows after experiencing issues with proprietary software file formats.[2][3]
| Mermaid | |
|---|---|
 | |
| Developers | Knut Sveidqvist and contributors |
| Initial release | 2014 |
| Written in | TypeScript, JavaScript |
| Operating system | Cross-platform |
| Type | Diagramming and charting |
| License | MIT |
| Website | mermaid |
| Repository | |
Features
Mermaid allows users to create various types of diagrams using a Markdown-like syntax, including:[4]
- Flowcharts
- Sequence diagrams
- Class diagrams
- State diagrams
- Gantt charts
- Entity–relationship diagrams
The software provides both text-based and visual editing interfaces, allowing users to switch between the two modes.[2] Users can create diagrams through the Mermaid Live Editor, a web-based tool that provides real-time preview capabilities without requiring local installation.[5]
The use of LLMs makes it easier to create diagram using Mermaid, because they can prompt the LLMs to directly generate a Mermaid diagram without having to code by simply indicating the context[6].
History
Mermaid.js was created in 2014 by Swedish software architect Knut Sveidqvist to keep diagrams aligned with software documentation. Sveidqvist stated that the idea emerged after losing a Microsoft Visio file, which led him to pursue a text-based, Markdown-centric approach. The project name was inspired by The Little Mermaid, which his children were watching at the time.[7][8][9]
The project's goal is to describe diagrams in plain text kept in version control, helping documentation keep pace with development and addressing "doc-rot."[10] A guidebook on Mermaid, The Official Guide to Mermaid.js, was published in 2021.[11]
In 2022, Sveidqvist co-founded Mermaid Chart Inc. (referred to as Mermaid), which offers hosted editing tools and enterprise features distinct from the open-source library. The company's hosted and enterprise offerings are proprietary open-core extensions,[7][8] focusing on text-to-diagram workflows that support versioning, automation, and code review processes.[12][13]
Integration
Development
As of 2024, the project is developed under both open-source and commercial models. The core functionality remains open-source under the MIT License, while a commercial offering called Mermaid Chart provides additional features and hosted services.[2] The open-source project has garnered significant community engagement, with over 74,000 GitHub stars and 6,800 forks as of early 2025.[1]
In March 2024, the commercial entity raised $7.5 million in seed funding from investors including Open Core Ventures, Sequoia, and Microsoft's M12 fund.[2]
Recognition
The project received the JS Open Source Award in 2019 for "The Most Exciting Use of Technology."[26]
