name: mermaid description: “关于使用验证工具创建/编辑Mermaid图表的必读指南”
Mermaid 技能
使用此技能通过解析和渲染Mermaid图表,使用官方Mermaid CLI快速验证它们。
前提条件
- Node.js + npm(用于
npx)。 - 首次运行会通过Puppeteer下载一个无头Chromium。如果Chromium缺失,请设置
PUPPETEER_EXECUTABLE_PATH。
工具
验证图表
./tools/validate.sh diagram.mmd [output.svg]
- 解析并渲染Mermaid源代码。
- 非零退出码表示Mermaid语法无效。
- 使用
beautiful-mermaid打印ASCII预览(尽力而为;并非所有图表类型都受支持)。 - 如果省略
output.svg,SVG将被渲染到临时文件并丢弃。
工作流程(简短)
- 如果图表将放在Markdown中:首先在独立的
diagram.mmd文件中草拟(该工具仅验证纯Mermaid文件)。 - 编写/更新
diagram.mmd。 - 运行
./tools/validate.sh diagram.mmd。 - 修复CLI显示的任何错误。
- 一旦验证通过,将Mermaid块复制到Markdown文件中。