Mermaid语法必备
Mermaid是一种基于文本的图表生成工具,支持流程图、时序图、甘特图等多种图表类型。其核心语法包括图表类型声明(如graph TD表示流程图)、节点定义(A[文本])和连线语法(A-->B)。常用图表包括:1)流程图用于业务流程;2)时序图展示系统交互;3)甘特图管理项目进度;4)类图设计系统结构;5)状态图建模状态机。Mermaid支持样式自定义、动态交互和复杂布局优化,适用于代码管理和
·
Mermaid 是一种基于文本的图表生成工具,通过类 Markdown 语法实现可视化图表绘制。其语法简洁、支持多种图表类型,且天然适合代码管理和版本控制。以下是 Mermaid 的核心语法详解:
一、基础语法结构
1. 图表类型声明
所有图表以特定关键词开头,定义图表类型和方向:
- 流程图:
graph TD(上下布局)或flowchart LR(左右布局) - 时序图:
sequenceDiagram - 甘特图:
gantt - 类图:
classDiagram - 状态图:
stateDiagram
2. 通用语法规则
- 注释:以
%%开头,如%% 这是注释 - 节点定义:
节点ID[显示文本]或节点ID{条件文本}(菱形节点) - 连线语法:
节点A --> 节点B(箭头)、节点A --- 节点B(无箭头)
二、核心图表类型详解
1. 流程图(Flowchart)
应用场景:业务流程、算法逻辑、用户交互流程
语法要点:
- 节点形状:
[]:矩形(默认){}:菱形(条件判断)(()):圆形(开始/结束)
- 子图:用
subgraph定义逻辑分组
2. 时序图(Sequence Diagram)
应用场景:系统交互、API 调用时序
语法要点:
- 参与者定义:
participant 别名 as 显示名 - 消息类型:
->>:同步消息-->>:异步响应-x:异步请求(带叉箭头)
- 激活框:用
+和-标记处理时段
sequenceDiagram
A->>B+: 请求
B-->>A-: 响应
3. 甘特图(Gantt Chart)
应用场景:项目管理、任务进度跟踪
语法要点:
- 时间格式:
dateFormat定义日期格式(如YYYY-MM-DD) - 任务依赖:
after表示任务顺序关系 - 关键路径:
:crit标记关键任务
4. 类图(Class Diagram)
应用场景:面向对象系统设计
语法要点:
- 可见性标记:
+(public)、-(private)、#(protected) - 类关系:
- 继承:
--|> - 组合:
--* - 聚合:
--o
- 继承:
5. 状态图(State Diagram)
应用场景:状态机建模、生命周期管理
语法要点:
三、高级功能与优化
-
样式自定义
通过 CSS 类修改颜色、边框等属性: -
动态交互(HTML环境)
添加点击事件(需配合 JavaScript):<script> mermaid.initialize({ securityLevel: 'loose' }); </script> -
复杂布局技巧
- 隐藏节点:用
A[ ]创建空节点调整布局 - 长文本换行:用
<br>标签实现多行显示
- 隐藏节点:用
四、工具与资源推荐
- 在线编辑器:Mermaid Live Editor(https://mermaid.live)
- IDE 插件:VS Code 的 Mermaid 插件支持实时预览
- 智能生成工具:DeepSeek、Kimi 可通过自然语言生成 Mermaid 代码
- 官方文档:Mermaid 中文网(https://mermaid.nodejs.cn)
更多推荐


所有评论(0)