语法详解

用 Mermaid 在 Markdown 里画流程图/时序图/甘特图

不想为了一张流程图去开 Visio、draw.io?Mermaid 让你用几行文本就把图“写”出来,还能进 Git 版本库、跟着文档一起走。

一、Mermaid 是什么

Mermaid 是一个用文本生成图表的工具。它借用了代码块的写法:在 Markdown 里放一个语言标注为 mermaid 的围栏块,里面写图形描述,支持的渲染器(GitHub、Typora、Obsidian、很多文档站)就会把它渲染成图。

```mermaid
graph TD
  A[开始] --> B{条件?}
  B -- 是 --> C[执行]
  B -- 否 --> D[结束]
```

好处是:图是文本,能 diff、能版本管理、能随文档一起复制粘贴,改起来也比拖图形快得多。

二、流程图 flowchart

最常用的就是流程图。开头写 graph 加方向(TD 上下、LR 左右),节点用 [] 矩形、{} 菱形(判断)、() 圆角,箭头用 -->。

```mermaid
flowchart LR
  Start(需求) --> Draft[写草稿]
  Draft --> Review{评审}
  Review -- 通过 --> Pub[发布]
  Review -- 打回 --> Draft
```

常用节点形状:A[矩形]、B(圆角)、C{菱形}、D([ stadium ])。连线可加文字标签:A -- 标签 --> B。

三、时序图 sequenceDiagram

画“谁先说、谁后说”的交互特别合适,比如接口调用、用户登录流程:

```mermaid
sequenceDiagram
  participant U as 用户
  participant A as 应用
  participant S as 服务器
  U->>A: 点击登录
  A->>S: 发送账号密码
  S-->>A: 返回 token
  A-->>U: 登录成功
```

实线 ->> 表示请求,虚线 -->> 表示返回/响应;participant 给角色起别名更清爽。

四、甘特图 gantt

做项目排期时,用甘特图看任务时间线:

```mermaid
gantt
  title 网站上线计划
  dateFormat YYYY-MM-DD
  section 设计
    原型     :a1, 2026-11-01, 5d
    视觉稿   :a2, after a1, 4d
  section 开发
    前端     :b1, after a2, 10d
    联调     :b2, after b1, 5d
```

after 某任务 表示依赖关系,d 是天、w 是周。排期写法也和任务管理相关,可结合 Markdown 任务清单 一起用。

五、类图与思维导图简述

Mermaid 还能画更多:

  • 类图 classDiagram:写代码设计时描述类与关系。
  • 思维导图 mindmap:用层级列表快速梳理思路(较新语法,渲染器支持度不一)。
  • 状态图 stateDiagram:描述状态流转,如订单状态机。
  • 饼图 pie:展示占比。

提示:不同平台对 Mermaid 版本支持不一,复杂图形发布前务必在目标平台预览;本地可用 365Lab 编辑器 配合支持 Mermaid 的预览确认语法。

六、常见问题

Q:为什么我的 Mermaid 没渲染成图?
A:三种常见原因——渲染器不支持 Mermaid(老版 Typora/部分博客不支持)、语法写错(缺括号或方向关键字)、或围栏块语言写成了 markdown 而非 mermaid。先在支持的平台试最小示例。

Q:箭头上的中文标签不显示?
A:标签要用 -- 文字 --> 写法,且部分老版本对中文支持差,升级渲染器或换成英文标签再本地化。

Q:和代码块冲突吗?
A:不冲突。Mermaid 就是“语言标注为 mermaid 的代码块”,普通代码块照常显示,详见 Markdown 代码块。

Q:能导出图片吗?
A:可以。很多平台支持把渲染出的图右键保存,或用 Mermaid CLI(mmdc)批量导出 PNG/SVG,适合放进文档或 PPT(参见 用 Markdown 做 PPT)。


想用图表写项目文档,先学 Markdown 写 README;公式类表达看 Markdown 数学公式;从 Markdown 入门 系统学起更稳。梳理概念层级可配合 用 Markdown 画思维导图。

边写图边看效果

用 365Lab 在线编辑器把 Markdown 写好,再配合支持 Mermaid 的预览确认图形,免注册、内容本地保存。

免费开始写作 →