SuperAPI AI 工具集

mermaid-diagrams

办公与效率

查看项目

更新于 10-15 21:37

技能介绍

用途:该技能提供使用 Mermaid 文本语法创建专业软件图表的指南。Mermaid 通过简单文本定义渲染图表,使图表可版本控制、易于更新,并能与代码一同维护。

主要能力:覆盖多种图表类型。类图用于领域建模、面向对象设计与实体关系;时序图用于 API 请求/响应、认证流程、组件交互与方法调用序列;流程图用于用户旅程、业务流程、算法逻辑与部署流水线;ERD 用于数据库表关系与数据建模;C4 图用于多层级软件架构(系统上下文、容器、组件、代码);此外还包括状态图、Git 图、甘特图以及饼图/柱状图。

使用方式:所有图表遵循“首行声明图表类型,随后为定义内容”的结构。使用 %% 表示注释,换行与缩进可提升可读性但非必需。资料给出了类图、时序图、流程图与 ERD 的快速示例,并说明可按需查阅 references 目录下的 class-diagrams.md、sequence-diagrams.md、flowcharts.md、erd-diagrams.md、c4-diagrams.md 与 advanced-features.md 获取详细指导。导出可使用 CLI:npm install -g @mermaid-js/mermaid-cli 然后 mmdc -i input.mmd -o output.png。

限制与注意:注释中避免使用 {},否则会破坏图表;特殊字符需正确转义;未知单词或拼写错误会静默破坏图表,参数也会静默失败。主题、样式与布局配置参见 advanced-features.md。资料未提供收费、价格或平台支持等更多信息。