📊

流程图生成器

使用 Mermaid 语法和可视化编辑器创建流程图和图表

实用指南

图表类型

流程图
默认

Mermaid 代码

预览

点击预览按钮渲染图表

❓什么是 Mermaid 流程图

Mermaid 是一个基于文本的图表工具,可以从类似 markdown 的语法生成图表。它使用简单的文本描述而不是拖放编辑器来创建流程图、时序图、甘特图、类图、状态图等。语法使用关键字(graph、sequenceDiagram、gantt)后跟节点定义和连接(A-->B、participant Alice)。Mermaid 以 SVG 格式渲染图表,使其可缩放并可嵌入文档、wiki、演示文稿中。优点包括版本控制(图表即代码)、轻松更新、一致的样式以及不需要专门的图表软件。广泛用于 GitHub markdown、Notion、GitLab、Confluence 和技术文档。

✨功能特点

📊

多种图表类型

支持流程图(graph TB/LR)、时序图、甘特图、类图、状态机、ER 图、饼图、用户旅程图,带特定类型的语法和渲染
✏️

双重编辑模式

带 Mermaid 语法高亮、自动完成和错误检测的文本编辑器,或可视化拖放编辑器(可选),带双向代码同步以即时更新图表
🎨

可自定义主题

从内置主题(默认、森林、深色、中性)中选择或自定义颜色、字体、形状、线条样式、节点间距以实现与品牌匹配的一致图表外观
💾

多格式导出

将图表导出为 SVG(可缩放矢量)、PNG(带可自定义分辨率的栅格)、PDF(用于打印/共享)或复制 Mermaid 代码以嵌入 markdown 文档

🎯应用场景

技术文档

在 README 文件、wiki 和技术文档中创建系统架构图、API 流程图和流程文档。直接在 markdown 中嵌入 Mermaid 代码,让 GitHub、GitLab 和 Notion 自动渲染。

项目管理

使用甘特图规划项目时间线、可视化任务依赖关系和跟踪里程碑。以基于文本的图表形式更新项目计划,可以在版本控制中跟踪并轻松与团队成员分享。

业务流程文档

使用流程图记录业务流程、审批流程和用户旅程图。与利益相关者分享流程图表,并根据反馈轻松修改,无需专门的图表软件。

软件设计

使用类图设计软件架构,使用 ER 图建模数据库模式,使用状态图可视化状态机。将设计作为代码进行迭代,随项目发展而演进。

📚实用指南

Mermaid 语法基础

Mermaid 图表以类型声明开始:graph TD(流程图从上到下)、graph LR(从左到右)、sequenceDiagram、gantt、classDiagram、stateDiagram、erDiagram、pie。节点定义为 id[text] 或 id(text) 用于不同形状:[] 矩形、() 圆角、{} 菱形、(()) 圆形、[[]] 子例程。连接使用箭头:-->(实线)、-.->(虚线)、==>(粗线)、--text-->(带标签)。子图分组节点:subgraph title ... end。通过 %%{init: {'theme':'dark'}}%% 或内联样式 id:::className 样式化。注释以 %% 开始。特殊字符转义或引用。缩进以提高可读性。

图表类型特性

流程图:使用 graph TB/TD/BT/RL/LR 表示方向。支持决策节点(菱形)、过程(矩形)、开始/结束(圆角)。时序图:定义参与者、消息(->>、-->>、-x)、激活框(activate/deactivate)、注释(Note left/right of)。甘特图:定义带开始日期、持续时间、依赖关系(after taskId)的任务。类图:定义类、属性、方法、关系(继承 <|、组合 *--、聚合 o--)。状态图:状态、转换、选择节点。每种类型都有特定的语法规则和渲染逻辑。

渲染引擎

Mermaid.js 库将文本语法解析为抽象语法树 (AST),然后使用 D3.js 进行图形布局渲染为 SVG。布局算法:Dagre 用于流程图(分层布局)、力导向用于有机形状。SVG 生成创建形状(<rect>、<circle>、<path>)、文本(<text>)、连接器(<line>、带标记的 <path>)。主题通过嵌入 SVG 的 CSS 类应用。交互功能:缩放/平移、工具提示、点击处理程序。浏览器渲染使用 <div class="mermaid">...code...</div> 与 mermaid.initialize() 或独立 SVG 生成。使用 Puppeteer/mermaid-cli 的服务器端渲染可用于静态输出。

高级功能

Mermaid 支持高级图表:子图创建嵌套结构。使用 classDef 和 class 应用自定义 CSS 的样式。链接:click nodeId "url" 打开 URL。回调:click nodeId callback 触发 JavaScript 函数。节点中的 FontAwesome 图标:fa:fa-icon。使用引号在标签中进行 Markdown 格式化。序列支持循环(loop...end)、替代(alt/else/end)、并行(par...end)。甘特图支持部分、里程碑、活动/完成/关键状态。ER 图显示基数(||--o{,一对多)。安全性:清理用户输入以防止点击处理程序中的 XSS。版本兼容性:检查 Mermaid.js 版本以获得语法支持。

💬Frequently Asked Questions

❓什么是 Mermaid,为什么使用基于文本的图表?
Mermaid 是一个基于文本的图表工具,可以从类似 markdown 的语法生成图表。使用文本而不是图形编辑器提供关键优势:版本控制(图表可以像代码一样在 Git 中跟踪)、轻松协作(共享和编辑纯文本)、自动化(以编程方式生成图表)、一致性(主题确保统一样式)以及不需要专门的软件。它非常适合文档、技术写作和开发工作流程。
💬我可以使用 Mermaid 创建哪些类型的图表?
Mermaid 支持多种图表类型:流程图(流程图、决策树)、时序图(系统交互、API 调用)、甘特图(项目时间线)、类图(UML 对象模型)、状态图(状态机)、ER 图(数据库模式)、饼图(比例数据)、用户旅程图(用户流程)和 Git 图(分支历史)。每种类型都有用于节点、连接和属性的特定语法。
🔍如何导出图表以用于文档或演示文稿?
您可以导出多种格式的图表:SVG(可缩放矢量图形)用于任何尺寸的清晰渲染和在矢量工具中编辑、PNG(栅格图像)具有可自定义的分辨率用于嵌入文档、PDF 用于打印和共享,或直接复制 Mermaid 代码以嵌入 Markdown 文件、GitHub README、Notion 页面、GitLab wiki 或 Confluence 文档中,这些平台原生支持 Mermaid。
💡我可以自定义图表的外观吗?
可以,Mermaid 提供了丰富的自定义选项:内置主题(default、forest、dark、neutral)可更改整体配色方案。您可以使用 classDef 定义自定义 CSS 类并将其应用于节点。单个节点样式支持自定义形状、颜色、边框和字体。连接样式可以是实线、虚线或带可选标签的粗箭头。高级用户可以注入自定义 CSS 或使用主题变量来匹配品牌颜色和设计系统。
📚Mermaid 在所有平台上都支持吗?
Mermaid 在许多平台上得到原生支持,包括 GitHub、GitLab、Notion、Confluence、VS Code 和 Obsidian。对于不支持的平台,您可以将图表导出为 SVG 或 PNG 并作为图像嵌入。对于 Web 应用程序,您可以集成 Mermaid.js 库以启用客户端渲染。

💡使用方法

1️⃣

技术文档

在 README 文件、wiki 或技术文档中可视化系统架构、API 流程或流程。直接在 markdown 中嵌入 Mermaid 代码,让 GitHub/GitLab 自动渲染。
2️⃣

项目规划

使用甘特图规划项目时间线、任务依赖关系和里程碑。轻松以文本格式更新并在版本控制中跟踪更改。
3️⃣

系统设计

使用类图设计软件架构或使用 ER 图建模数据库模式。随着设计的发展迭代代码。
4️⃣

工作流文档

使用流程图记录业务流程、审批工作流或用户旅程。与利益相关者共享并根据反馈轻松修改。
5️⃣

演示和报告

将图表导出为高质量 SVG 或 PNG 以包含在演示文稿、报告或文档中。自定义主题以获得一致的样式。

User Comments

0 / 2000
Loading...