用途:用 Mermaid 的文本语法创建专业软件图表。图表由文本定义渲染而来,便于纳入版本控制、更新并与代码一起维护。
主要能力:支持类图(领域建模、面向对象设计、实体关系)、时序图(API 请求/响应、认证流程、组件交互、方法调用序列)、流程图(用户旅程、业务流程、算法逻辑、部署流水线)、ERD(数据库架构、表关系、数据建模)、C4(系统上下文、容器、组件、代码层级)、状态图、git graph(分支策略)、甘特图(项目时间线)以及饼图/柱状图。
使用方式:所有图表遵循 diagramType 加定义内容的结构,首行声明图表类型(如 classDiagram、sequenceDiagram、flowchart),用 %% 写注释,换行和缩进提高可读性但非必需。参考文件包括 references/quick-start-examples.md 及 class-diagrams、sequence-diagrams、flowcharts、erd-diagrams、c4-diagrams、architecture-diagrams、advanced-features 等。主题通过 frontmatter 配置,可选 default、forest、dark、neutral、base;布局可选 dagre(默认)或 elk(需集成);外观可选 classic 或 handDrawn。导出可用 Mermaid Live Editor(PNG/SVG)、Mermaid CLI(npm install -g @mermaid-js/mermaid-cli 后 mmdc -i input.mmd -o output.png)或 Docker(docker run --rm -v $(pwd):/data minlag/mermaid-cli -i /data/input.mmd -o /data/output.png)。GitHub/GitLab、VS Code、Notion、Obsidian、Confluence 原生支持渲染。
最佳实践与限制:从简单核心实体开始逐步补充细节,使用有意义的名称,多用 %% 注释,一个图表聚焦一个概念,将 .mmd 文件与代码一起版本控制,添加标题和说明。未知单词会破坏图表,参数会静默失败;注释中避免 {},特殊字符需正确转义;语法错误会破坏图表,可在 Mermaid Live 中验证;过于复杂时应拆分为多个聚焦视图,并记录所有重要关系。elk 布局需要额外集成。资料未提供具体收费或价格信息。