SuperAPI AI 工具集

mermaid-diagrams

通用与其它

查看项目

更新于 10-16 03:37

技能介绍

用途:当一段说明用 Mermaid 图表达比纯文字更清晰直观时,使用该技能生成专业软件图。Mermaid 以简单文本定义生成图表,因此图可版本控制、易更新,并能与代码一起维护。\n\n主要能力:覆盖大量图类型,包括流程图(流程、算法、决策树、用户旅程)、时序图(API 请求响应、认证流程、组件交互)、类图(领域建模、OOP 设计、实体关系)、ERD(数据库表关系与建模)、C4(系统上下文、容器、组件、代码级架构)、状态图、Git 图、甘特图、饼图、象限图、XY 图、雷达图、桑基图、思维导图、时间线、看板、块图、数据包图、需求图、矩形树图、维恩图、石川图、Wardley 地图、树视图、事件建模、ZenUML、架构图、用户旅程图等,并提供各图类型的详细参考文件。\n\n使用方式:所有图遵循“diagramType + 定义内容”的结构,首行声明图类型,%% 用于注释,换行与缩进提升可读性但非必需。可在 GitHub/GitLab Markdown、VS Code(Markdown Mermaid 扩展)、Notion、Obsidian、Confluence 中原生渲染;可用 Mermaid Live Editor 导出 PNG/SVG,或用 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。支持通过 frontmatter 配置主题(default、forest、dark、neutral、base)、布局(dagre、elk)和外观(classic、handDrawn)。\n\n适用场景与最佳实践:适合新项目或新功能启动、复杂系统文档、架构决策说明、数据库模式设计、重构规划、新人入职等;建议从核心实体开始逐步细化、使用有意义命名、多用注释、一张图聚焦一个概念、将 .mmd 文件与代码一起版本控制。\n\n限制与常见问题:未知词会破坏图表,参数错误会静默失败;注释中避免使用 {};特殊字符需正确转义;语法拼写错误会导致图无法渲染,可在 Mermaid Live 中验证;复杂图建议拆分为多个聚焦视图。