mermaid-cli

Overview

GitHubGitHub

mermaid-cli 是 [Mermaid](https://mermaid.js.org/) 图表库的命令行接口（CLI）工具。它读取 Mermaid 定义文件作为输入，生成 SVG、PNG 或 PDF 格式的图像文件作为输出。此外，它还支持转换嵌入在 Markdown 文件中的 Mermaid 代码块。 ### 主要能力 - **多格式输出**：支持将 `.mmd` 文件转换为 SVG、PNG 和 PDF 格式。 - **Markdown 处理**：可以读取包含 Mermaid 代码块的 Markdown 模板文件，将其中的图表渲染为 SVG 文件，并在输出的 Markdown 文件中自动替换为对应的图片引用。 - **主题与背景自定义**：通过命令行参数指定主题（如 `dark`）和背景（如 `transparent`）。 - **自定义图标包**：支持通过 npm 安装的图标包或通过 URL/本地 URI 引入的图标包来扩展 Mermaid 的图标能力。 - **CSS 动画支持**：使用 `--cssFile` 选项内联自定义 CSS，可用于为生成的 SVG 添加动画效果。 - **尺寸控制**：通过 `--size` 参数设置生成 PNG 的尺寸限制。 - **标准输入支持**：支持通过管道（stdin）直接传入 Mermaid 图表定义进行转换。 ### 安装方式 除了通过 npm 全局或本地安装外，mermaid-cli 还提供了 Docker/Podman 镜像，以及 Node.js API 调用方式。需要注意的是，Node.js API 不受 semver 语义化版本控制的保护。Homebrew 的安装方式已不再受支持。 ### 适用人群 适合需要在 CI/CD 流程中自动生成图表、编写文档时需要批量处理 Mermaid 图表，或者希望在终端环境中快速预览和导出 Mermaid 图表的开发者和文档编写者。

Q&A

如何安装 mermaid-cli？AI-generated

可以通过 npm 全局安装：`npm install -g @mermaid-js/mermaid-cli`。如果全局安装遇到问题，也可以本地安装后通过 `./node_modules/.bin/mmdc` 调用，或使用 npx：`npx -p @mermaid-js/mermaid-cli mmdc`。此外还支持通过 Docker 或 Podman 运行。

如何将 Mermaid 文件转换为 SVG？AI-generated

使用命令 `mmdc -i input.mmd -o output.svg`，其中 `-i` 指定输入的 Mermaid 文件，`-o` 指定输出的 SVG 文件路径。

如何处理 Markdown 文件中的 Mermaid 图表？AI-generated

使用命令 `mmdc -i readme.template.md -o readme.md`。工具会查找 Markdown 中的 Mermaid 代码块，生成对应的 SVG 文件，并在输出的 Markdown 中将代码块替换为图片引用。

如何生成带有深色主题和透明背景的 PNG？AI-generated

可以使用命令 `mmdc -i input.mmd -o output.png -t dark -b transparent`，通过 `-t` 指定主题为 dark，通过 `-b` 指定背景为 transparent。

如何通过 stdin 传递图表数据？AI-generated

可以将输入参数设置为 `-` 来从 stdin 读取。例如使用 heredoc：`cat << EOF | mmdc --input -`，然后输入图表定义即可。

Node.js API 是否遵循 semver 版本规范？AI-generated

不遵循。原文指出 Node.js API 不受 semver 保护，因为 mermaid-cli 遵循的是 mermaid 的版本控制策略。

还能用 Homebrew 安装吗？AI-generated

不能。原文明确警告通过 brew 安装的方法已不再受支持。