一款风格固定的代码格式化工具，可将 JavaScript、TypeScript、CSS、Markdown 等代码统一为一致的格式。
5.2万5011JavaScriptMIT更新于 昨天
- Star
- 90,776
- Fork
- 9,374
- 未关闭 Issue
- 1,938
- 最近提交
- 10小时前
这是什么？
Mermaid 是一个基于 JavaScript 和 TypeScript 的绘图工具，将文本定义渲染为图表。你只需用简短的文本描述流程图或时序图等内容，Mermaid 就会在浏览器中或构建阶段将其输出为 SVG。由于图表本身是纯文本，可以和代码一起存放、在 Pull Request 中审阅，并随系统变化随时重新生成。
该项目支持多种图表类型，包括流程图、时序图、类图、状态图、ER 图、甘特图、饼图、Git 图、思维导图、时间线、用户旅程图和 C4 图。可以通过 npm 包、CDN 脚本或在线 Live Editor 使用，GitHub 也能直接在 Markdown 文件中渲染 Mermaid 代码块。
对于不可信输入，Mermaid 会进行基础的内容清理；对于接受外部用户图表代码的网站，还可以启用沙箱 iframe 渲染模式，代价是部分交互功能会被禁用。
核心功能
- 01根据文本渲染流程图、时序图、类图、状态图、ER 图、甘特图等多种图表。
- 02图表以纯文本保存，可在版本控制中清晰地对比和审阅。
- 03可在 GitHub Markdown 中直接使用，也可通过 npm 包或 CDN 脚本引入。
- 04支持主题、颜色、字体和布局方向的自定义。
- 05提供沙箱渲染模式，用于处理不可信的图表输入。
适用场景
- 将架构图和时序图与对应代码一起保存在代码仓库中。
- 在 GitHub README 和文档站点中嵌入图表。
- 在构建流程中生成甘特图、饼图等图表。
- 让非开发人员在在线 Live Editor 中快速绘制图表。
快速上手
- 1
在 Mermaid Live Editor（mermaid.live）中即时试用图表
标签
常见问题
- mermaid 是什么？
- Mermaid 用类 Markdown 的文本语法生成流程图、时序图、甘特图等多种图表。 Mermaid 是一个基于 JavaScript 和 TypeScript 的绘图工具，将文本定义渲染为图表。你只需用简短的文本描述流程图或时序图等内容，Mermaid 就会在浏览器中或构建阶段将其输出为 SVG。由于图表本身是纯文本，可以和代码一起存放、在 Pull Request 中审阅，并随系统变化随时重新生成。
- mermaid 可以免费使用吗？用的什么许可证？
- mermaid 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。
- mermaid 还在维护吗？
- 活跃维护中。mermaid 最近一次提交是在 2026年10月20日。
- mermaid 适合用来做什么？
- 将架构图和时序图与对应代码一起保存在代码仓库中。 在 GitHub README 和文档站点中嵌入图表。 在构建流程中生成甘特图、饼图等图表。 让非开发人员在在线 Live Editor 中快速绘制图表。
- mermaid 怎么安装和运行？
- 在 Mermaid Live Editor（mermaid.live）中即时试用图表
- 在哪里获取 mermaid？
- 源代码和安装说明在 GitHub 上：https://github.com/mermaid-js/mermaid
概要由 AI 根据项目 README 生成；GitHub 数据每日更新。
相关项目
一款无需构建过程、可将 Markdown 文件直接转为文档网站的工具。
3.2万5784JavaScriptMIT更新于 4小时前
将 JavaScript 代码转换为 SVG 流程图的库与命令行工具，支持抽象层级、代码块修饰和主题定制。
7105478JavaScriptMIT更新于 3年前
一种基于 C4 模型思路的架构建模语言与工具链，可从代码生成实时更新的架构图。
5909402TypeScriptMIT更新于 前天
一款 Markdown 文档编译器，将同一份源文件输出为静态文档站点、离线搜索、llms.txt 和 AI 上下文。
2528144TypeScriptMIT更新于 4天前
一个脚手架工具，把可编辑的 Astro 文档站点生成到你的仓库中，内置面向智能体的 Markdown 与 llms.txt 输出。
143152TypeScriptMIT更新于 前天