Mermaid

Mermaid 简介

Mermaid 是一个基于 JavaScript 的图表绘制工具，它使用类似 Markdown 的文本定义来生成和修改复杂图表。其主要目标是帮助文档跟上开发进度，解决“文档腐烂”问题。

核心特性

• 文本即图表：用简洁的文本语法描述流程图、时序图、类图、状态图、甘特图、饼图等。
• 多平台集成：可直接在 GitHub、GitLab、Notion 等平台渲染，也提供在线编辑器。
• 易于维护：图表定义可纳入版本控制，随代码一起更新。
• 丰富的图表类型：支持流程图、时序图、类图、状态图、实体关系图、用户旅程图、甘特图、饼图、需求图等。

快速示例

以下是一个简单的流程图定义：

graph TD;
    A[开始] --> B{判断};
    B -->|是| C[执行操作];
    B -->|否| D[结束];

在支持 Mermaid 的 Markdown 编辑器中，这段文本会自动渲染为流程图。

使用方式

• 在线编辑器：访问 Mermaid Live Editor 实时编辑和预览。
• 集成到项目：通过 npm 安装 mermaid 包，在网页中调用 API 渲染。
• 文档平台：GitHub、GitLab 等已原生支持 Mermaid 代码块。

适用场景

Mermaid 非常适合技术文档、项目 README、架构设计、流程说明等场景，帮助团队用代码化的方式维护图表，提升文档的可读性和可维护性。