mcpField
M
mermaid

mermaid

github.com/ahgraber文档处理650 次安装今天更新
代码仓库

关于 mermaid

mermaid 是一项用于在聊天机器人中创建 Mermaid 图表的技能,面向需要 Markdown 图表或图像文件的用户。它可用本地 Mermaid CLI 校验语法并渲染图像,无需调用网页服务。

主要功能

  1. 01生成 Mermaid 图表代码
  2. 02支持流程图、时序图和状态图
  3. 03使用本地 CLI 校验语法
  4. 04渲染 SVG、PNG 或 PDF
  5. 05遵循聊天界面的图表格式指南

适用场景

  1. 01为聊天回复编写 Markdown 图表
  2. 02检查图表代码是否有效
  3. 03将图表导出为图像或 PDF
  4. 04为聊天界面调整图表可读性

安装

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

$npx skills add https://github.com/ahgraber/skills --skill mermaid

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

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
chatbot-mermaid-guidelines.md
scripts/
render_mermaid.py
validate_mermaid.py

详细介绍

聊天机器人的 Mermaid 图表

使用此技能创建可在 Markdown 聊天界面中良好呈现的 Mermaid 图表,在本地验证其语法,并在不调用 Web 服务的情况下渲染图像。

调用提示

  • 使用此技能时,请告知用户技能名称:mermaid。

工作流

  1. 根据请求确定图表类型(flowchart、sequenceDiagram、stateDiagram-v2)。
  2. 在使用 mermaid 的 Markdown 围栏代码块中起草 Mermaid 代码。
  3. 遵循 references/chatbot-mermaid-guidelines.md 中的格式规范。
  4. 使用 scripts/validate_mermaid.py 验证图表。
  5. 如果用户需要图像文件,使用 scripts/render_mermaid.py 进行渲染。

脚本

  • scripts/validate_mermaid.py
    • 调用本地 Mermaid CLI(mmdc)验证 Mermaid 代码。
    • 需要检查 Mermaid 是否能无错误解析时使用。
  • scripts/render_mermaid.py
    • 使用本地 Mermaid CLI(mmdc)将 Mermaid 渲染为 SVG/PNG/PDF。
    • 需要嵌入图像时,Markdown 渲染器优先使用 SVG。

备注

  • 这些脚本要求 PATH 中包含 mmdc(Mermaid CLI)。 如果缺少该工具,请指导用户在本地安装;不要使用 Mermaid Web 服务。
  • 依赖项通过各 Python 脚本中的内联 uv 脚本元数据进行管理。 需要时,使用 --install-chromium 通过 pyppeteer 安装 Chromium 二进制文件。
  • 图表应简洁易读,适合在聊天界面中查看:避免图形过宽,使用简短标签,并将相关状态分组。
  • 如果用户要求原始 Markdown,只返回围栏代码块中的 mermaid 内容,除非用户要求补充说明。

评论

支持 Markdown