1. REDIRECT Mermaid (software)
Mermaid
DevelopersKnut Sveidqvist and contributors
Initial release2014; 11 years ago (2014)
Repositorygithub.com/mermaid-js/mermaid
Written inJavaScript
Operating systemCross-platform
TypeDiagramming and charting
LicenseMIT License
Websitemermaid.js.orgmermaid.ai

Mermaid.js is an open-source JavaScript library that renders diagrams from plain-text descriptions written in a Markdown-like domain-specific language (DSL).[1] It is commonly used in documentation and developer workflows where diagrams are stored, versioned, and reviewed as text alongside source code. Several platforms, including GitHub, render Mermaid inside Markdown.[2][3]

History

[edit]

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.[4][5][6]

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."[7]

Publication

[edit]

The Official Guide to Mermaid.js (Packt, 2021)[8][9] by Knut Sveidqvist and Ashish Jain provides an introduction to Mermaid syntax and usage, covering diagram types such as flowcharts, sequence, class, state, ER, and Gantt diagrams, as well as theming and documentation workflows.

Open core company

[edit]

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.[10][11] The commercial products focus on text-to-diagram workflows, facilitating versioning, automation, and code reviews.[12][13] The company announced a US$7.5 million seed round in March 2024. Reported investors included Open Core Ventures, Microsoft's M12, and funds affiliated with Sequoia Capital.[14][15][16]

Development

[edit]

The project is developed under both open-source and commercial models. The core functionality remains open-source under the MIT License.[17]

Open-source tools: Mermaid diagrams can be authored and previewed without local installation using the open-source Mermaid Live Editor. The open-source Mermaid Live Editor provides a web preview and export interface.[18][19] Commercial tools: Mermaid provides a visual editor and AI-assisted features (such as text-to-diagram and file-assisted diagramming). These are a part of the Mermaid product and are distinct from the open-source Mermaid library.[20][21]

Features

[edit]

Diagram Types

[edit]

Mermaid defines multiple diagram classes expressed as plain text (for example, flowcharts, sequence, class, state, and entity-relationship diagrams). Additional types have been added over time; the v11 documentation lists user-journey, Gantt, mindmap, timeline, and others.[20][22] Diagrams can be rendered client-side in the browser or generated via CLI and CI/CD workflows.[23][24]

Syntax

[edit]

Mermaid diagrams are authored as plain text in fenced code blocks using a concise domain-specific language.[25][26] For example:

Flowchart (example):

flowchart TD

 A[Text description] --> B[Mermaid code]
 B --> C[Rendered diagram]
 C --> D[Review / version]

Usage

[edit]

Typical use of Mermaid involves writing diagrams in plain-text Mermaid syntax, rendering them locally or on supported platforms, storing the source with documentation or code, and automating updates in CI/CD pipelines.

A text-first workflow commonly includes:

Author the diagram as a short text block in Mermaid syntax..[27] Render locally or on platforms that support Mermaid (for example, GitHub renders Mermaid in Markdown in issues, discussions, pull requests, wikis, and files).[2] Store and review the diagram source with related documentation or code so changes can be versioned and reviewed like other text (commonly on Git hosts).[24] Automate generation or updates in CI/CD as part of documentation or build pipelines.[24][13][28] Use with AI systems where available: editor/IDE extensions and assistant features can draft Mermaid text from natural language for subsequent human editing.[29][30]

Integrations

[edit]

Major developer platforms document built-in Mermaid rendering, including GitHub [2][3][31], GitLab[32][33][34], and Azure DevOps wikis.[35][36] Other software forges and ALM tools (such as Gitea and Tuleap) document support in their Markdown or wiki components.[37][38]

Editors and IDEs

[edit]

Mermaid can be authored or previewed in a number of editors through extensions or built-in support. Examples include Visual Studio Code[39][40][41], JetBrains IDEs[42], Notion[43], Obsidian[44], Joplin[45], and Quarto[46].

Several AI-assisted development tools can generate or validate Mermaid syntax, typically via editor extensions or chat-based assistants; for example, GitHub Copilot Chat[47][48] documents Mermaid diagram generation, and editors also expose Mermaid through chat participants or Model Context Protocol integrations[49].

Work management and productivity software

[edit]

Diagram creation and embedding are available through apps or add-ons for Atlassian Confluence[50] and Jira[51], Microsoft 365[52][53] (PowerPoint and Word), and Google Docs[54]

Additional editor and static-site integrations are listed in the project's integrations page and vendor documentation.[55]

Comparison

[edit]

Text-first vs. visual editors

[edit]

Mermaid uses a text-based DSL and renders from source text, which can be versioned and reviewed like code. CLI and API support automation and CI/CD.[24][17]

diagrams.net (previously draw.io) is primarily a graphical editor (web/desktop) with diagram files stored as XML and broad app integrations (e.g., Atlassian).[56]

PlantUML is another text-based system for diagram specification; it provides a different syntax and tooling approach.[57]

Graphviz focuses on graph layouts (e.g., DOT language) and is widely used for pipelines and graph structures.[58]

This section summarizes different diagramming approaches without implying preference.

Reception

[edit]

Mermaid and its related tools have been discussed in developer media, particularly regarding "diagrams-as-code" workflows and platform integrations.[3][59][13][60]

In 2019, Mermaid received the JavaScript Open Source Award for "The Most Exciting Use of Technology."[61]

See also

[edit]

Graphviz PlantUML Microsoft Visio Lucidchart

References

[edit]
  1. ^ "About Mermaid". Mermaid.js documentation. mermaid-js. Retrieved 27 October 2025.
  2. ^ a b c "Creating diagrams". GitHub Docs. GitHub. Retrieved 27 October 2025.
  3. ^ a b c Biagianti, Adam (14 February 2022). "Include diagrams in your Markdown files with Mermaid". The GitHub Blog. Retrieved 27 October 2025.
  4. ^ Chowdhry, Amit (26 August 2024). "Mermaid Chart: How This Company Creates Complex Diagrams From Markdown-Style Code". Pulse 2.0. Retrieved 27 October 2025.
  5. ^ Lardinois, Frederic (20 March 2024). "Mermaid Chart, a Markdown-like tool for creating diagrams, raises $7.5M". TechCrunch. Retrieved 27 October 2025.
  6. ^ Lindberg, Erica (10 October 2022). "Why we invested in Mermaid Chart". Open Core Ventures. Retrieved 27 October 2025.
  7. ^ Chowdhry, Amit (26 August 2024). "Mermaid Chart: How This Company Creates Complex Diagrams From Markdown-Style Code". Pulse 2.0. Retrieved 27 October 2025.
  8. ^ Sveidqvist, Knut; Jain, Ashish (2025). The Official Guide to Mermaid.js: Create complex diagrams and beautiful flowcharts easily using text and code. Packt Publishing. ISBN 978-1-80107-802-3. Retrieved 27 October 2025.
  9. ^ "The Official Guide to Mermaid.js — Code Repository". GitHub. Packt Publishing. Retrieved 27 October 2025.
  10. ^ Chowdhry, Amit (26 August 2024). "Mermaid Chart: How This Company Creates Complex Diagrams From Markdown-Style Code". Pulse 2.0. Retrieved 27 October 2025.
  11. ^ Lardinois, Frederic (20 March 2024). "Mermaid Chart, a Markdown-like tool for creating diagrams, raises $7.5M". TechCrunch. Retrieved 27 October 2025.
  12. ^ "Mermaid Chart (Ecosystem)". Mermaid.js documentation. mermaid-js. Retrieved 27 October 2025.
  13. ^ a b c Joshua Meiri. "Visual Thinking Meets Code: How Mermaid.js Is Transforming Process Design". Origami Precision — Insights. Retrieved 27 October 2025.
  14. ^ Lardinois, Frederic (20 March 2024). "Mermaid Chart, a Markdown-like tool for creating diagrams, raises $7.5M". TechCrunch. Retrieved 27 October 2025.
  15. ^ "Mermaid Chart Raises $7.5M to Reinvent Visual Thinking". Yahoo Finance. 20 March 2024. Retrieved 3 November 2025.
  16. ^ "Mermaid Chart Raises $7.5M in Seed Funding". FinSMEs. 20 March 2024. Retrieved 27 October 2025.
  17. ^ a b "Mermaid". GitHub. mermaid-js. Retrieved 27 October 2025.
  18. ^ "Announcements". Mermaid.js documentation. Retrieved 27 October 2025.
  19. ^ "Mermaid Live Editor". Mermaid Live Editor. mermaid-js. Retrieved 27 October 2025.
  20. ^ a b "Getting started". Mermaid.js documentation. mermaid-js. Retrieved 27 October 2025.
  21. ^ "Mermaid — Diagramming with AI and code". Mermaid. Retrieved 27 October 2025.
  22. ^ "Diagram Syntax". Mermaid.js documentation. Retrieved 27 October 2025.
  23. ^ "Diagram Syntax". Mermaid.js documentation. Retrieved 27 October 2025.
  24. ^ a b c d "mermaid-cli". GitHub. mermaid-js. Retrieved 27 October 2025.
  25. ^ Chowdhry, Amit (26 August 2024). "Mermaid Chart: How This Company Creates Complex Diagrams From Markdown-Style Code". Pulse 2.0. Retrieved 27 October 2025.
  26. ^ "Flowcharts — Basic Syntax". Mermaid documentation. Mermaid Chart. 22 May 2025. Retrieved 3 November 2025.
  27. ^ "Diagram Syntax". Mermaid.js documentation. Retrieved 27 October 2025.
  28. ^ "@mermaid-js/mermaid-cli — v9.0.1". npm. Retrieved 27 October 2025.
  29. ^ Pot, Justin (13 November 2024). "Use Mermaid to Create Charts and Diagrams Without Image Editing Tools". LifeHacker. Retrieved 27 October 2025.
  30. ^ "vscode-mermAId". Visual Studio Marketplace. Microsoft. Retrieved 27 October 2025.
  31. ^ Elliot, Ian (15 February 2022). "GitHub Supports Mermaid For Creating Diagrams". I Programmer. Retrieved 27 October 2025.
  32. ^ "AsciiDoc". GitLab Docs. GitLab. Retrieved 27 October 2025.
  33. ^ "Wiki". GitLab Docs. GitLab. Retrieved 27 October 2025.
  34. ^ "GitLab Flavored Markdown (GLFM)". GitLab Docs. GitLab. Retrieved 27 October 2025.
  35. ^ "Wiki — Sprint 158 Update". Microsoft Learn. Microsoft. 4 October 2022. Retrieved 27 October 2025.
  36. ^ "Wiki — Sprint 200 Update". Microsoft Learn. Microsoft. 4 October 2022. Retrieved 27 October 2025.
  37. ^ "Compared to other Git hosting". Gitea Documentation. Gitea. Retrieved 27 October 2025.
  38. ^ "Tuleap 12.7". Tuleap. April 2021. Retrieved 27 October 2025.
  39. ^ "Mermaid Chart extension for Visual Studio Code". Visual Studio Marketplace. Microsoft. Retrieved 27 October 2025.
  40. ^ "Mermaid Chart Announces Visual Studio Code Plugin". Mermaid Chart Blog. Mermaid Chart. 17 July 2023. Retrieved 27 October 2025.
  41. ^ "Visual Studio Code plugin". Mermaid Chart Docs. Mermaid Chart. Retrieved 27 October 2025.
  42. ^ "JetBrains IDE plugin". Mermaid Chart Docs. Mermaid Chart. Retrieved 27 October 2025.
  43. ^ "Hack week". Notion — What's New. Notion Labs, Inc. 23 December 2021. Retrieved 27 October 2025.
  44. ^ "Obsidian 0.7.6 Desktop (Public)". Obsidian Changelog. Obsidian. 2 July 2020. Retrieved 27 October 2025.
  45. ^ "Markdown Guide". Joplin Help. Joplin. Retrieved 27 October 2025.
  46. ^ "Diagrams". Quarto Documentation. Posit. Retrieved 27 October 2025.
  47. ^ "October 2024 (version 1.95)". Visual Studio Code. Microsoft. October 2024. Retrieved 3 November 2025.
  48. ^ "Creating diagrams". GitHub Docs. GitHub. Retrieved 3 November 2025.
  49. ^ "Connectors". Claude. Anthropic. Retrieved 3 November 2025.
  50. ^ "Confluence plugin". Mermaid Chart Docs. Mermaid Chart. Retrieved 27 October 2025.
  51. ^ "Mermaid Chart for Jira". Atlassian Marketplace. Atlassian. Retrieved 27 October 2025.
  52. ^ "Microsoft Word plugin". Mermaid Chart Docs. Mermaid Chart. Retrieved 27 October 2025.
  53. ^ "Microsoft PowerPoint plugin". Mermaid Chart Docs. Mermaid Chart. Retrieved 27 October 2025.
  54. ^ "Mermaid Chart for Google Docs™". Google Workspace Marketplace. Google. Retrieved 27 October 2025.
  55. ^ "Integrations — Community". Mermaid.js documentation. mermaid-js. Retrieved 27 October 2025.
  56. ^ "Mermaid Diagrams Won't Replace Diagrams.net for Me, But it Sure is Fun". Podfeet Podcasts. 20 December 2022. Retrieved 27 October 2025.
  57. ^ "PlantUML". PlantUML. Retrieved 27 October 2025.
  58. ^ "Graphviz". Graphviz. Retrieved 27 October 2025.
  59. ^ Chowdhry, Amit (26 August 2024). "Mermaid Chart: How This Company Creates Complex Diagrams From Markdown-Style Code". Pulse 2.0. Retrieved 27 October 2025.
  60. ^ Pot, Justin (13 November 2024). "Use Mermaid to Create Charts and Diagrams Without Image Editing Tools". LifeHacker. Retrieved 27 October 2025.
  61. ^ "JavaScript Open Source Awards 2019 — Winners". GitNation. Retrieved 27 October 2025.