mermaid.cli参数速查表:mmdc全部8个选项完整清单,主题、宽高、背景色一次讲透
【免费下载链接】mermaid.cliDevelopment has been moved to https://github.com/mermaid-js/mermaid-cli项目地址: https://gitcode.com/gh_mirrors/me/mermaid.cli
mermaid.cli 是 Mermaid 图表的命令行渲染工具:一条mmdc命令,就能把.mmd图表文件导出为 SVG、PNG 或 PDF 图片。本速查表整理了 mmdc 全部 8 个选项,重点讲透主题、宽高、背景色这三个最常用的参数,帮你快速掌握 Mermaid CLI 参数用法。
📌 mermaid.cli 能做什么?
一句话:把文字写的图表,变成图片文件。
用 Mermaid 语法写好流程图、时序图后,命令行直接渲染成可嵌入文档、PPT、网页的图片:
mmdc -i test/flowchart.mmd -o flowchart.svg输入是test/目录下的示例图表文件,输出就是同名 SVG 图片。参数记不住?随时运行mmdc -h查看内置帮助。
🔍 mmdc 全部 8 个选项速查表
以下 8 个选项是渲染图表时的完整清单(定义见index.js),一张表记牢:
| 选项 | 全称 | 作用 | 默认值 |
|---|---|---|---|
-i | --input | 输入的 mermaid 文件(必填) | — |
-o | --output | 输出文件,仅支持 svg / png / pdf | 输入名 +.svg |
-t | --theme | 主题:default / forest / dark / neutral | default |
-w | --width | 页面宽度(整数) | 800 |
-H | --height | 页面高度(整数) | 600 |
-b | --backgroundColor | 背景色,支持颜色名、色值、transparent | white |
-c | --configFile | mermaid 的 JSON 配置文件 | — |
-C | --cssFile | 页面的 CSS 样式文件 | — |
另外还有:
-V查看版本、-h查看帮助,以及进阶选项-p(传入 Puppeteer 配置文件,下文会讲)。
🎨 三个关键参数详解:主题、宽高、背景色
用 -t 一键切换图表主题
mmdc -i test/sequence.mmd -o sequence-forest.png -t forest内置 4 套主题:
- default:经典浅色,通用场景
- forest:蓝绿配色,清爽耐看
- dark:深色背景,适合深色模式文档
- neutral:灰调低调,商务感强
用 -w 和 -H 设置页面宽高
这两个参数决定渲染视口大小,直接影响输出图片的清晰度与排版:
mmdc -i test/flowchart.mmd -o flowchart.png -w 1024 -H 768💡 小贴士:导出 PNG 时把宽度调大一些,图放大会更清晰;SVG 是可缩放的,对宽高不太敏感。
用 -b 设置背景色与透明导出
mmdc -i test/flowchart.mmd -o flowchart.png -b '#FFF000' mmdc -i test/flowchart.mmd -o flowchart.png -b transparent- 支持颜色名(如
red)、十六进制色值(如'#F0F0F0') transparent是必会技巧:透明背景的 PNG 放进任何 PPT 或文档都不违和
📁 三个文件类选项:-c、-C、-p
用 -c 加载 mermaid 配置文件
想批量调整主题、节点样式、时序图边距时,写一份 JSON 配置文件即可,项目里的test/config.json就是现成范例:
{ "theme": "forest", "flowchart": { "useMaxWidth": false, "htmlLabels": true }, "themeCSS": ".node rect { fill: red; }" }使用方式:mmdc -i test/flowchart.mmd -o out.png -c test/config.json
用 -C 自定义页面样式
传入一个 CSS 文件,渲染时会被注入页面,可调整字体、内边距等细节,可参考项目中的test/index.css。
用 -p 解决 Linux 沙箱问题
在 Linux 上运行偶尔会报 "No usable sandbox" 错误。创建puppeteer-config.json:
{ "args": ["--no-sandbox"] }再用mmdc -p puppeteer-config.json ...传入即可。⚠️ 更推荐的做法:避免以 root 身份运行,并保持系统内核更新。
⚡ 3 个实战命令组合(可直接复制)
| 使用场景 | 命令 |
|---|---|
| 嵌入网页文档 | mmdc -i test/flowchart.mmd -o flowchart.svg |
| 放进 PPT 演示 | mmdc -i test/flowchart.mmd -o flowchart.png -w 1024 -b transparent |
| 打印归档 | mmdc -i test/sequence.mmd -o sequence.pdf -t dark |
❓ 常见踩坑问答
Q1:装了之后找不到 mmdc 命令?
全局安装可能因权限问题未注册命令,推荐本地安装:npm install mermaid.cli,然后用./node_modules/.bin/mmdc -h调用(详见 README 中的安装说明)。
Q2:不指定 -o 时输出什么格式?
默认输出与输入同名的.svg文件。
Q3:项目还在更新吗?
mermaid.cli已不再活跃维护,官方开发已迁移至新包@mermaid-js/mermaid-cli,旧版本参数仍可参考本速查表。
✅ 总结
记住这一行,就掌握了 mmdc 参数速查表的核心:
mmdc -i input.mmd -o output.png -t forest -w 1024 -H 768 -b transparent-i/-o管输入输出,-t管颜值,-w/-H管尺寸,-b管背景,-c/-C负责进阶定制——8 个选项,从此不求人。
【免费下载链接】mermaid.cliDevelopment has been moved to https://github.com/mermaid-js/mermaid-cli项目地址: https://gitcode.com/gh_mirrors/me/mermaid.cli
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考