Mermaid (software)
   HOME

TheInfoList



OR:

Mermaid is an open-source JavaScript-based diagramming and charting tool that generates diagrams from text-based descriptions. 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.


Features

Mermaid allows users to create various types of diagrams using a Markdown-like syntax, including: * 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. Users can create diagrams through the Mermaid Live Editor, a web-based tool that provides real-time preview capabilities without requiring local installation.


Integration

Mermaid is supported natively by several platforms and services: * Azure DevOps (in project wikis) *
GitHub GitHub () is a Proprietary software, proprietary developer platform that allows developers to create, store, manage, and share their code. It uses Git to provide distributed version control and GitHub itself provides access control, bug trackin ...
(in Markdown files) *
Gitea Gitea () is a forge software package for hosting software development version control using Git as well as other collaborative features like bug tracking, code review, continuous integration, kanban boards, tickets, and wikis. It supports self ...
*
GitLab GitLab is a software forge primarily developed by GitLab Inc. It is available as a community edition and a commercial edition. History GitLab was created in 2011 by Ukrainian programmer Dmitriy Zaporozhets as a side project written in Rub ...
* Joplin * Tuleap *
Notion Notion or Notions may refer to: Software * Notion (music software), a music composition and performance program * Notion (productivity software), a note-taking and project-management program from Notion Labs, Inc. * Notion (window manager), the ...
*
Obsidian Obsidian ( ) is a naturally occurring volcanic glass formed when lava extrusive rock, extruded from a volcano cools rapidly with minimal crystal growth. It is an igneous rock. Produced from felsic lava, obsidian is rich in the lighter element ...
* Quarto


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. The open-source project has garnered significant community engagement, with over 74,000 GitHub stars and 6,800 forks as of early 2025. 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.


Recognition

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


See also

*
PlantUML PlantUML is an open-source tool allowing users to create diagrams from a plain text language. Besides various Unified Modeling Language, UML diagrams, PlantUML has support for various other software development related formats (such as Archimate, ...
*
Graphviz Graphviz (short for ''Graph Visualization Software'') is a package of open-source software, open-source tools initiated by AT&T Labs, AT&T Labs Research for Graph drawing, drawing graph (discrete mathematics), graphs (as in Vertex (graph theory ...
*
Microsoft Visio Microsoft Visio (, ), formerly Microsoft Office Visio, is a diagramming and vector graphics application and is part of the Microsoft 365 Business. The product was first introduced in 1992 by former American software company Visio Corporation, an ...
*
Lucidchart Lucidchart is a web-based diagramming application that allows users to visually collaborate on drawing, revising and sharing charts and diagrams, and improve processes, systems, and organizational structures. It is produced by Lucid Software In ...


References

{{reflist 2014 software Cross-platform software Diagramming software Free and open-source software Free software programmed in JavaScript Software using the MIT license Visualization software