SuperAPI AI 工具集

mermaid-cli

通用与其它

查看项目

更新于 10-15 20:32

技能介绍

用途:mmdc 把 .mmd 或 Markdown 中的 Mermaid 定义渲染为 SVG、PNG 或 PDF,无需浏览器手动操作,用于脚本化、自动化地生成发布级图表,也可校验语法。

主要能力:支持流程图、时序图、类图、状态图、ER 图、甘特图、饼图、思维导图、时间线、Git 图、用户旅程、桑基图、C4、象限图、XY 图、块图、架构图、ZenUML 等。内置 default、forest、dark、neutral 四种主题,可用配置文件或 CSS 自定义;可用 -w/-H/-s 控制宽高与缩放,-b 设背景色,--pdfFit 让图表适配 PDF 页面。处理 Markdown 时会把 ```mermaid 代码块替换为指向生成图片的 img 标签(-e 可指定 png)。

使用方式:先验证是否安装:mmdc --version。常用命令:mmdc -i diagram.mmd -o diagram.svg(SVG 为默认推荐格式);PNG 用 -o diagram.png;PDF 用 -o diagram.pdf。示例:mmdc -i diagram.mmd -o diagram.png -t dark -b white;mmdc -i diagram.mmd -o diagram.svg -c mermaid-config.json;mmdc -i README.md -o README-out.md。可用 -p 传入 Puppeteer 配置(如 --no-sandbox、executablePath、timeout)。校验语法时先渲染到临时文件,-q 静默并检查退出码,非零即语法错误,据此迭代修正。

适用场景:自动化文档与报告配图、CI 中校验图表语法、批量替换 Markdown 中的 Mermaid 块、需要 SVG/PNG/PDF 多格式输出的工程流程。

限制:需要 Node.js(^18.19 或 >=20)、Puppeteer 与无头 Chromium(约 200MB);大型或复杂图渲染可能超时;图标包需联网从 unpkg.com 下载;PDF 输出不支持自定义背景色。安装依赖未提供,若 mmdc 不存在需用户手动安装,可选方式包括 npm install -g @mermaid-js/mermaid-cli、npx -p @mermaid-js/mermaid-cli mmdc --help、docker pull minlag/mermaid-cli。