Communitygithub.com

ahundt/mermaid-diagrams

使用 beautiful-mermaid 和 bun 将 Mermaid 图表渲染为 SVG。当用户要求“渲染 mermaid”、“生成图表”、“创建流程图”、“更新图表”、“从 mermaid 渲染 SVG”、“beautiful-mermaid”、“重新生成图表”或需要将 Mermaid 图表语法转换为带样式的 SVG 文件时使用。支持所有 Mermaid 图表类型,包含 15 个主题,如 tokyo-night。

mermaid-diagrams 是什么?

该技能提供了一套工具,用于将 Mermaid (.mmd) 文件渲染为带有 beautiful-mermaid 主题的 SVG 文件,利用 bun 进行高速执行。它专为 AI Agent(如 Claude Code 或 Cursor)设计,当用户要求生成或更新图表时自动触发。核心功能是一个 CLI 工具 `render-mermaid.ts`,支持单文件、多文件以及管道输入,并内置 15 个主题(默认 tokyo-night)。技能文档还包含一个用于 Gemini 图像生成的提示,以生成项目概览图。已知限制是复杂图表(尤其是深度嵌套的子图)可能触发 dagre 布局错误,但不会阻断其他渲染任务。

兼容平台~Claude Code~Codex CLI~Cursor✓Gemini CLI
npx skills add https://github.com/ahundt/autorun/tree/HEAD/plugins/autorun/skills/mermaid-diagrams

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

使用 beautiful-mermaid 渲染 Mermaid 图表

使用 beautiful-mermaid v1.0.2 和 bun 将 Mermaid .mmd 文件渲染为带样式的 SVG。

技能内容

文件用途
render-mermaid.tsCLI 工具:将 .mmd 文件渲染为 SVG
gemini-diagram-prompt.mdGemini 图像生成提示

安装

仅需安装 bun。beautiful-mermaid 依赖会在首次运行时由 bun 自动安装。

# macOS
brew install oven-sh/bun/bun

# 通用安装程序
curl -fsSL https://bun.sh/install | bash

CLI 参考

render-mermaid — 将 Mermaid .mmd 文件渲染为主题化 SVG

用法:
  bun run render-mermaid.ts [选项] <输入.mmd...>
  echo 'graph TD; A-->B' | bun run render-mermaid.ts -o 输出.svg

选项:
  -o, --output <文件>   输出文件(仅限单个输入)
  --outdir <目录>       多个文件的输出目录
  -t, --theme <名称>    主题(默认:tokyo-night)
  --list-themes         列出可用主题
  --help                显示帮助

输出默认行为: 若不指定 -o 或 --outdir,则在每个输入文件旁写入 <名称>.svg(-d 会被 bun run 忽略;请使用 --outdir)。

快捷方式: 设置 MERMAID=plugins/autorun/skills/mermaid-diagrams/render-mermaid.ts 以缩短命令。

示例

MERMAID=plugins/autorun/skills/mermaid-diagrams/render-mermaid.ts

# 渲染单个文件(输出在输入文件旁)
bun run $MERMAID diagram.mmd

# 渲染到指定输出文件
bun run $MERMAID diagram.mmd -o pretty.svg

# 渲染所有 .mmd 文件到输出目录
bun run $MERMAID docs/diagrams/*.mmd --outdir docs/diagrams

# 使用不同主题
bun run $MERMAID -t dracula diagram.mmd

# 从标准输入管道
 echo 'graph TD; A-->B-->C' | bun run $MERMAID -o quick.svg

# 列出主题
bun run $MERMAID --list-themes

项目图表

Mermaid 源文件(.mmd)和渲染输出(.svg)位于 docs/diagrams/,另有一个源文件位于仓库根目录:

源文件描述
docs/diagrams/autofile-policy.mmdAutoFile 策略流程图
docs/diagrams/three-stage-autorun.mmd三阶段自动运行流程图
autorun-architecture.mmd完整架构(对 beautiful-mermaid 来说过于复杂)

重新生成:

bun run $MERMAID docs/diagrams/*.mmd --outdir docs/diagrams

已知限制

  • 包含深度嵌套子图的复杂图表可能触发 dagre 布局错误。失败的图表会被报告,但不会阻塞其他渲染。
  • %%{init:...}%% 前置内容会被自动剥离(beautiful-mermaid 会应用自己的主题)。

<image_generation>

Gemini 图像生成

gemini-diagram-prompt.md 包含一个用于 Gemini 生成以目标为导向的项目概览图像的提示。将提示复制到 Gemini 对话中即可。

</image_generation>

Individual skills in this repo

This repo contains 2 individual skills — each has its own dedicated page.

相关技能