Mermaid 简介
什么是 Mermaid
Mermaid 是一个基于 JavaScript 的图表和图解工具,可以让你使用文本和代码创建图表和可视化内容。它使用受 Markdown 启发的文本定义来动态创建和修改图表。如果你熟悉 Markdown,学习 Mermaid 的语法应该不成问题。
Mermaid 的主要目的是帮助文档跟上开发的步伐。Doc-Rot 是一个 Mermaid 帮助解决的 Catch-22 问题。绘图和文档编写会占用宝贵的开发时间,并且很快就会过时。但是没有图表或文档会降低生产力并损害组织的学习能力。Mermaid 通过让用户能够创建易于修改的图表来解决这个问题,它也可以成为生产脚本(以及其他代码片段)的一部分。Mermaid 甚至允许非程序员通过 Mermaid Live Editor 轻松创建详细的图表。
图表类型
Mermaid 支持多种类型的图表,包括:
- 流程图 (Flowchart)
- 序列图 (Sequence diagram)
- 甘特图 (Gantt diagram)
- 类图 (Class diagram)
- Git 图 (Git graph)
- 实体关系图 (Entity Relationship Diagram) - 实验性
- 用户旅程图 (User Journey Diagram)
- 象限图 (Quadrant Chart)
- XY 图 (XY Chart)
下面我们将详细介绍每种图表类型及其示例。
1. 流程图 (Flowchart)
流程图用于描述过程的步骤和决策点。下面是一个简单的流程图示例:
2. 序列图 (Sequence diagram)
序列图用于显示对象之间的交互以及交互发生的顺序。下面是一个简单的序列图示例: