Mermaid (software)

This article may rely excessively on sources too closely associated with the subject, potentially preventing the article from being verifiable and neutral. Please help improve it by replacing them with more appropriate citations to reliable, independent sources. (May 2025) (Learn how and when to remove this message)

|

Open-source JavaScript-based diagramming and charting tool

Mermaid

Developer(s)| Knut Sveidqvist and contributors
Initial release| 2014
Repository| github.com/mermaid-js/mermaid
Written in| JavaScript
Operating system| Cross-platform
Type| Diagramming and charting
License| MIT
Website| mermaid.js.org

Mermaid is an open-source JavaScript-based diagramming and charting tool 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]

## Features

[edit]

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]

## Integration

[edit]

Mermaid is supported natively by several platforms and services:[6][7]

* Azure DevOps (in project wikis)[8]
* GitHub (in Markdown files)[9][10]
* Gitea[11]
* GitLab[12]
* Joplin[13]
* Tuleap[14]
* Notion[15]
* Obsidian[16]
* Quarto [17]

## Development

[edit]

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

[edit]

The project received the JS Open Source Award in 2019 for "The Most Exciting Use of Technology."[18]

## See also

[edit]

* Free and open-source software portal

* PlantUML
* Graphviz
* Microsoft Visio
* Lucidchart

## References

[edit]

1. ^ a b "Mermaid GitHub Repository". GitHub.
2. ^ a b c d Frederic Lardinois (March 20, 2024). "Mermaid Chart, a Markdown-like tool for creating diagrams, raises $7.5M". TechCrunch.
3. ^ Amit Chowdhry (Aug 26, 2024). "Mermaid Chart: How This Company Creates Complex Diagrams From Markdown-Style Code". Pulse 2.0.
4. ^ Kerry Doyle (December 12, 2023). "A review of software architecture visualization tools". TechTarget.
5. ^ "Mermaid Live Editor".
6. ^ Justin Pot (November 13, 2024). "Use Mermaid to Create Charts and Diagrams Without Image Editing Tools". LifeHacker.
7. ^ "Mermaid Integrations".
8. ^ "Markdown Guidance for Wikis – Azure DevOps". 6 September 2024.
9. ^ "Include diagrams in Markdown files with Mermaid on GitHub". 14 February 2022.
10. ^ Ian Elliot (February 15, 2022). "GitHub Supports Mermaid For Creating Diagrams". I Programmer.
11. ^ "Gitea - Compared to other Git hosting".
12. ^ "Gitlab Handbook".
13. ^ "Joplin - Markdown Guide".
14. ^ "Tuleap 12.7".
15. ^ "Notion – Release Notes 2021-12-23".
16. ^ "Obsidian Changelog 0.7.6".
17. ^ "Quarto – Diagram Authoring".
18. ^ ""Mermaid" – Notes by NicFab". 22 March 2022.