SuperAPI AI 工具集

mermaid

写作与研究

查看项目

更新于 10-15 16:47

技能介绍

用途:本资料给出在 GitHub Markdown 中编写 Mermaid 图表、使其良好渲染的基本规则,适用于在 README、Issue 或文档中嵌入流程图、时序图等场景。

主要能力与支持类型:需使用 mermaid 开始、 结束的围栏代码块。GitHub 支持较好的类型包括 graph(流程图,推荐 TD)、sequenceDiagram、classDiagram、stateDiagram-v2(优先 v2)、erDiagram、pie、gantt、mindmap(仅基础结构)。应避免过新或较少见的图表类型,因为 GitHub 的 Mermaid 版本可能滞后。

语法要点:节点 ID 使用简单字母数字,避免空格或特殊字符;节点、参与者、状态标签建议用引号,含空格或特殊字符时尤为重要。使用标准箭头,如 -->、---、==>、->>。注释用 %%。流程图倾向 TD/TB 垂直布局;单个图表应保持聚焦,避免节点、连线或嵌套过多,可拆分为多个简单图表。

mindmap(GitHub)限制:用缩进定义层级,每个节点单独一行;GitHub 不支持 ::icon() 等实验性或高级功能,使用图标会导致渲染错误,应只用纯文本节点。

样式与验证:不要设置主题或在内联代码中使用 classDef、style 自定义样式,GitHub 会忽略主题指令并按自身明暗模式应用样式;应在 GitHub 预览中检查渲染效果。自动编辑工具可能难以正确处理 Mermaid 块,需仔细复核,必要时手动修正。

限制与未提供信息:资料未提供安装方式、收费、平台、性能或效果等事实。