Mermaid 图表教程:用文字画流程图、时序图与甘特图

Mermaid 是一种“用文字描述图表”的语法。不用拖方框、也不用另存图片,只要在 Markdown 里写几行文字,阅读器就会自动画出图表。文字版图表好修改、方便版本管理,GitHub、GitLab、Notion 和墨阅都支持。

怎么在 Markdown 里写 Mermaid

用三个反引号开启代码块,语言标注为 mermaid:

```mermaid
flowchart LR
    A[开始] --> B[结束]
```

把这段放进 .md 文件,用墨阅打开,就会看到一张从左到右的流程图。点击图表右上角的“放大查看”可以缩放细节。

流程图 flowchart

第一行声明方向:TD(从上到下)或 LR(从左到右)。节点用不同的括号决定形状:

flowchart TD
    A[方形节点] --> B(圆角节点)
    B --> C{判断}
    C -->|是| D[[子流程]]
    C -->|否| E((圆形))
  • --> 是箭头,--- 是无箭头连线,-.-> 是虚线箭头。
  • |文字| 放在箭头上,用来标注条件。
  • 节点代号(A、B、C)只要不重复即可,画面上显示的是括号里的文字。

时序图 sequenceDiagram

适合描述系统之间、用户与服务之间的交互顺序:

sequenceDiagram
    participant U as 用户
    participant S as 服务器
    U->>S: 提交登录信息
    S-->>U: 返回登录结果
    Note over U,S: 全程使用 HTTPS

->> 是实线箭头(请求),-->> 是虚线箭头(响应)。Note over 可以添加注释。

甘特图 gantt

项目进度一目了然:

gantt
    title 网站改版计划
    dateFormat YYYY-MM-DD
    section 设计
    需求访谈 :a1, 2025-01-06, 5d
    界面设计 :after a1, 7d
    section 开发
    前端开发 :2025-01-20, 10d
    测试上线 :5d

饼图 pie

pie title 每日时间分配
    "工作" : 8
    "睡眠" : 7
    "阅读" : 2
    "其他" : 7

状态图 stateDiagram

stateDiagram-v2
    [*] --> 草稿
    草稿 --> 审核中: 提交
    审核中 --> 已发布: 通过
    审核中 --> 草稿: 退回
    已发布 --> [*]

常见错误与排查

  • 图表没有出现:确认代码块标注的是 mermaid,并且第一行有图表类型(flowchart、sequenceDiagram 等)。
  • 文字包含特殊符号:节点文字包含括号、冒号时,用双引号括起来,例如 A["价格 (含税)"]。
  • 方向写错:flowchart 后面只能接 TB、TD、BT、RL、LR。
  • 墨阅遇到错误时,会保留源码并显示错误原因,其余内容仍可正常阅读。

小技巧

  • 图表太大时,改用 LR 方向通常更好读。
  • 同一份文档可以放多张图表,墨阅每个文件最多绘制 40 张。
  • 切换到“夜读”主题,图表配色也会跟着改变;导出 PDF 时会自动改用浅色。

想看实际效果?在墨阅首页点击“图表・公式・运行示例”,就能打开一份带 Mermaid 图表的示例文档。