mermaid-js /mermaid
Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
★ 91,110⑂ 9,496👁 636⑃ 4,290● 3,966▤ 229
+10
Daily
+62
Weekly
91,110
stars
9,496
forks
636
watchers
4,290
prs
3,966
issues
229
releases
README
Mermaid Generate diagrams from Markdown-like text. Live Editor! 📖 Documentation | 🚀 Getting Started | 🌐 CDN | 🙌 Join Us 简体中文 Try Live Editor previews of future releases: Develop | Next :trophy: Mermaid was nominated and won the JS Open Source Awards (2019) in the category "The most exciting use of technology"!!! Thanks to all involved, people committing pull requests, people answering questions! 🙏 Table of content Expand contents - About - Examples - Release - Related projects - Contributors - Security and safe diagrams - Reporting vulnerabilities - Appreciation About -- Mermaid is a JavaScript-based diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams. The main purpose of Mermaid is to help documentation catch up with development. Doc-Rot is a Catch-22 that Mermaid helps to solve. Diagramming and documentation costs precious developer time and gets outdated quickly. But not having diagrams or docs ruins productivity and hurts organizational learning. Mermaid addresses this problem by enabling users to create easily modifiable diagrams. It can also be made part of production scripts (and other pieces of code). Mermaid allows even non-programmers to easily create detailed diagrams through the Mermaid Live Editor. For video tutorials, visit our Tutorials page. Use Mermaid with your favorite applications, check out the list of Integrations and Usages of Mermaid. You can also use Mermaid within GitHub as well many of your other favorite applications—check out the list of Integrations and Usages of Mermaid. For a more detailed introduction to Mermaid and some of its more basic uses, look to the Beginner's Guide, Usage and Tutorials. Our PR Visual Regression Testing is powered by Argos with their generous Open Source plan. It makes the process of reviewing PRs with visual changes a breeze. In our release process we rely heavily on visual regression tests using applitools. Applitools is a great service which has been easy to use and integrate with our tests. -- Features - 20+ Diagram Types – Flowchart, Sequence, Class, State, ER, Gantt, Pie, Git Graph, Mindmap, Timeline, Sankey, and more - Markdown-Inspired Syntax – Write diagrams as text, no drag-and-drop required - No Design Tool Needed – Generate professional diagrams straight from code - Live Editor – Prototype instantly at mermaid.live - Version-Control Friendly – Diagrams live as text, so diffs and reviews just work - Native GitHub Rendering – Mermaid code blocks render directly in Markdown on GitHub - Highly Customizable – Themes, colors, fonts, and layout directions - Security First – Built-in sanitization plus a sandboxed rendering mode - Lightweight – Small footprint, no heavy dependencies - Active Community – Frequent releases and thousands of contributors - Open Source – MIT licensed Examples The following are some examples of the diagrams, cha
Top issues
#523Styling components of the sequence diagram103 comments · 2017-04-20#1462Component Diagram79 comments · 2020-06-10#2623BPMN support57 comments · 2022-01-13#1227New diagram type: network topology57 comments · 2020-01-28#2977Move the subgraph label to the bottom left corner51 comments · 2022-04-27#821Note in flowchart diagram51 comments · 2019-04-11#3208Backwards arrow direction46 comments · 2022-07-06#3989New Diagram Type: Tree Chart45 comments · 2023-01-13
Discussions
#8790Introducing Archimaid: ArchiMate® Diagrams for Mermaid0 comments · 2026-11-14#8736Help needed to run required E2E checks for PR #85060 comments · 2026-11-09#8685Mermaid v13: going on a diet, and we want your input4 comments · 2026-11-04#8569flowchart: left directed arrow ⟵ (edges) is missing; is it possible to include, Thanks.0 comments · 2026-10-26#8468Mermaid Timeline Editor: In-browser editor with live preview and SVG export0 comments · 2026-10-18#8418SeqShow: step-by-step Mermaid sequence presentations with offline HTML export1 comments · 2026-10-10#8346Is anyone familiar with this type of diagram?0 comments · 2026-09-29#8325By default embedded fonts?1 comments · 2026-09-27
Latest release
@mermaid-js/[email protected] @mermaid-js/[email protected] 2026-11-13Minor Changes - 8779 eb56a54 Thanks @sidharthv96! - feat: add swimlane diagram examples, so editors such as the Live Editor list the diagram
相关报道 (7)
iThome OnlineGitHub原生支援在Markdown檔案以Mermaid語法編輯圖表2022-02-14智源社区GitHub最热架构图Agent,开发者故事看哭了2026-09-0151CTO“让 Token 消耗降低 61%”:腾讯开源 Agent Memory2026-05-1551CTO手搓了一个 Skill,让 AI 画出我心目中的流程图2026-03-27QQ NewsCursor 1.0正式登场,支持画架构图,还支持一键MCP,不过有些抽象2025-06-0651CTO2024前端数据可视化常用工具大盘点2024-08-27新浪财经再不用怕Markdown中的绘图了,GitHub官方支持Mermaid图表绘制工具2022-02-15
News & coverage (10)
Hacker NewsMermaid: Generation of diagrams like flowcharts or sequence diagrams from text▲ 255 · 107 comments · 2025-05-21Hacker NewsMermaid: Create complex diagrams using Markdown-inspired▲ 69 · 3 comments · 2022-02-15HackerNoonBuilding a Docs-as-Code Workflow With Markdown, Mermaid, and GitHub Actions2026-10-28GIGAZINEGitHub supports 'Mermaid', a library that automatically creates graphs from text2022-02-16I ProgrammerGitHub Supports Mermaid For Creating Diagrams2022-02-14BetaNewsGitHub adds native support for JavaScript-based diagramming tool, Mermaid2022-02-14GIGAZINEObsidian creator kepano has released 'Pele,' a lightweight open-source library that uses CSS for theme settings and renders Mermaid diagrams as SVGs.2026-10-20Visual Studio MagazineVS Code 1.121 Adds Remote Agents, Boosts Claude Code Functionality Again2026-05-20The GitHub BlogGitHub Copilot in Visual Studio — January update2026-02-04The GitHub BlogInclude diagrams in your Markdown files with Mermaid2022-02-14