mcpField
M
mermaid

mermaid

github.com/mitsuhiko文档处理3.2k152 次安装5 周前更新
代码仓库

关于 mermaid

用于通过官方 Mermaid CLI 验证 Mermaid 图表的技能,帮助图表作者发现语法错误,并可选择保存渲染后的 SVG。

主要功能

  1. 01解析并渲染 Mermaid 文件
  2. 02语法无效时返回失败状态码
  3. 03尽力输出 ASCII 预览
  4. 04可选保存渲染后的 SVG

适用场景

  1. 01将图表加入 Markdown 前检查语法
  2. 02将验证通过的图表渲染为 SVG 文件

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/mitsuhiko/agent-stuff --skill mermaid

安装后在 Claude Code 中输入/mermaid确认已加载。

附带文件tools/validate.sh

详细介绍

Mermaid 技能

使用此技能,通过官方 Mermaid CLI 解析并渲染 Mermaid 图表,快速验证图表。

前置条件

  • 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 将渲染到临时文件并丢弃。

工作流(简版)

  1. 如果图表将放在 Markdown 中:先在独立的 diagram.mmd 文件中起草(此工具只验证纯 Mermaid 文件)。
  2. 编写或更新 diagram.mmd。
  3. 运行 ./tools/validate.sh diagram.mmd。
  4. 修复 CLI 显示的错误。
  5. 验证通过后,将 Mermaid 代码块复制到 Markdown 文件中。

评论

支持 Markdown