关于 mermaid
为 Mermaid 图表编写提供语法指导的技能,面向需要在文档中创建图表的人。内容涵盖多种图表类型、常见语法限制与排错方式。
主要功能
- 01涵盖多种 Mermaid 图表类型
- 02说明节点与连线语法
- 03列出常见语法冲突
- 04提供图表排错建议
适用场景
- 01编写流程图或时序图
- 02在子图中组织节点
- 03修复无法渲染的图表
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ markdown-viewer/ skills --skill mermaid安装后在 Claude Code 中输入/mermaid确认已加载。
附带文件references/syntax.md
详细介绍
Mermaid 图表可视化工具
快速入门: 确定图表类型(流程图/时序图/状态图/类图/ER 图/甘特图/思维导图)→ 定义带形状的节点 → 用箭头连接 → 用 ```mermaid 代码围栏包裹。默认方向为自上而下(TD),优先使用 flowchart 而不是 graph,支持 Unicode。
关键语法规则
规则 1:列表语法冲突
❌ [1. Item] → "Unsupported markdown: list"
✅ [1.Item] → Remove space after period
✅ [① Item] → Use circled numbers ①②③④⑤⑥⑦⑧⑨⑩
✅ [(1) Item] → Use parentheses
规则 2:子图命名
❌ subgraph AI Agent Core → Space without quotes
✅ subgraph agent["AI Agent Core"] → ID with display name
✅ subgraph agent → Simple ID only
规则 3:子图中的节点引用
❌ Title --> AI Agent Core → Reference display name
✅ Title --> agent → Reference subgraph ID
规则 4:节点文本中的特殊字符
✅ ["Text with spaces"] → Quotes for spaces
✅ Use #quot; instead of " → Avoid quotation marks
✅ Use #lpar;#rpar; for () → Avoid parentheses
规则 5:优先使用 flowchart 而不是 graph
❌ graph TD → Outdated
✅ flowchart TD → Supports subgraph directions, more features
常见问题
| 问题 | 解决方案 |
|---|---|
| 图表无法渲染 | 检查括号或引号是否匹配 |
| 列表语法错误 | 使用 [1.Item],而不是 [1. Item] |
| 子图引用失败 | 使用 ID,而不是显示名称 |
| 图表过于拥挤 | 拆分为多个图表 |
| 连线交叉 | 使用不同的布局方向或隐形连线 ~~~ |
输出格式
```mermaid
[diagram code]
```
相关文件
有关图表特定语法和高级功能,请参阅以下参考资料:
- syntax.md — 涵盖全部 14 种以上图表类型的详细语法:流程图形状、时序图参与者、类图关系、状态转换、ER 基数、甘特图任务等
评论
支持 Markdown