Mermaid (software)
{{Third-party|date=May 2025}}
{{Short description|Open-source JavaScript-based diagramming and charting tool}}
{{Infobox software
| name = Mermaid
| logo = Mermaid Logo.svg
| developer = Knut Sveidqvist and contributors
| released = 2014
| programming language = JavaScript
| operating system = Cross-platform
| genre = Diagramming and charting
| license = MIT
| website = {{URL|https://mermaid.js.org/}}
| repo = {{URL|https://github.com/mermaid-js/mermaid}}
}}
Mermaid is an open-source JavaScript-based diagramming and charting tool that generates diagrams from text-based descriptions.{{cite web |url=https://github.com/mermaid-js/mermaid |title=Mermaid GitHub Repository|website=GitHub }} 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.{{cite web |url=https://techcrunch.com/2024/03/20/mermaid-chart-a-markdown-like-tool-for-creating-diagrams-raises-5-5m/ |title=Mermaid Chart, a Markdown-like tool for creating diagrams, raises $7.5M |date=March 20, 2024 |author=Frederic Lardinois |website=TechCrunch}}{{cite web |url=https://pulse2.com/mermaid-chart-knut-sveidqvist-profile/ |title=Mermaid Chart: How This Company Creates Complex Diagrams From Markdown-Style Code |author=Amit Chowdhry |website=Pulse 2.0 |date=Aug 26, 2024}}
Features
Mermaid allows users to create various types of diagrams using a Markdown-like syntax, including:{{cite web |url=https://www.techtarget.com/searchapparchitecture/tip/A-review-of-top-software-architecture-visualization-tools |title=A review of software architecture visualization tools |date=December 12, 2023 |author=Kerry Doyle |website=TechTarget}}
- 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.{{cite web |url=https://mermaid.live |title=Mermaid Live Editor}}
Integration
Mermaid is supported natively by several platforms and services:{{cite web |url=https://lifehacker.com/tech/mermaid-creates-diagrams-and-flowcharts-with-plaintext |title=Use Mermaid to Create Charts and Diagrams Without Image Editing Tools |date=November 13, 2024 |author=Justin Pot |website=LifeHacker}}{{cite web |url=https://mermaid.js.org/ecosystem/integrations-community.html|title=Mermaid Integrations}}
- Azure DevOps (in project wikis){{cite web |url=https://learn.microsoft.com/en-us/azure/devops/project/wiki/markdown-guidance?view=azure-devops |title=Markdown Guidance for Wikis – Azure DevOps|date=6 September 2024 }}
- GitHub (in Markdown files){{cite web |url=https://github.blog/developer-skills/github/include-diagrams-markdown-files-mermaid/ |title=Include diagrams in Markdown files with Mermaid on GitHub|date=14 February 2022 }}{{cite web |url=https://www.i-programmer.info/news/90-tools/15217-github-supports-mermaid-for-creating-diagrams.html |title=GitHub Supports Mermaid For Creating Diagrams |date=February 15, 2022 |author=Ian Elliot |website=I Programmer}}
- Gitea{{cite web |url=https://docs.gitea.com/installation/comparison|title=Gitea - Compared to other Git hosting}}
- GitLab{{cite web |url=https://handbook.gitlab.com/handbook/tools-and-tips/mermaid/|title=Gitlab Handbook}}
- Joplin{{cite web |url=https://joplinapp.org/help/apps/markdown/|title=Joplin - Markdown Guide}}
- Tuleap{{cite web |url=https://www.tuleap.org/resources/release-notes/tuleap-12-7|title=Tuleap 12.7}}
- Notion{{cite web |url=https://www.notion.com/releases/2021-12-23 |title=Notion – Release Notes 2021-12-23}}
- Obsidian{{cite web |url=https://obsidian.md/changelog/2020-07-02-desktop-v0.7.6/ |title=Obsidian Changelog 0.7.6}}
- Quarto {{cite web |url=https://quarto.org/docs/authoring/diagrams.html |title=Quarto – Diagram Authoring}}
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."{{cite web |url=https://notes.nicfab.eu/en/posts/mermaid/ |title="Mermaid" – Notes by NicFab|date=22 March 2022 }}
See also
{{Portal|Free and open-source software}}