用途:用 Mermaid 的文本语法创建专业软件图表,让图表可版本控制、易更新,并与代码一同维护。
主要能力:支持类图(领域建模、OOP 设计、实体关系)、时序图(API 流程、认证流程、组件交互)、流程图(流程、算法、决策树、用户旅程)、ERD(数据库模式、表关系、数据建模)、C4 图(系统上下文、容器、组件、架构)、状态图、Git 图和甘特图。可通过 frontmatter 配置主题(default、forest、dark、neutral、base)、布局(dagre、elk)和外观(classic、handDrawn)。
使用方式:所有图表遵循“首行声明图表类型,随后为定义内容”的模式,%% 用于注释。安装命令:npx clawhub@latest install mermaid-diagrams。GitHub/GitLab、VS Code、Notion、Obsidian、Confluence 原生支持渲染;导出可用 Mermaid Live Editor 或 Mermaid CLI:npm install -g @mermaid-js/mermaid-cli 后执行 mmdc -i input.mmd -o output.png。
适用场景:新项目或功能启动、记录复杂系统、解释架构决策、设计数据库模式、规划重构、新成员入职,以及对齐技术决策、可视化数据流与系统交互。
限制与注意:未知词会破坏图表,无效参数会静默失败;避免在注释中使用 {},特殊字符需转义,建议在 Mermaid Live 中校验。单个图表不要超过 15 个节点,箭头需标注,图表需有标题或说明,且不应作为唯一文档,架构变更后需及时更新。Mermaid 不适用于业务数据可视化图表。