简介

mermaid-cli 是由 Mermaid 官方提供的命令行工具，用于将 Mermaid 语法的文本转换为 SVG / PNG / PDF。

Mermaid 是一个基于 JavaScript 的图表绘制工具，它使用简单的文本描述语法，就可以绘制出流程图、时序图、甘特图等多种图表。

首次用户

1. 使用 x env use mermaid-cli 即可自动下载并使用

   • 在终端运行 eval "$(curl https://get.x-cmd.com)" 即可完成 x 命令安装, 详情参考 x-cmd 官网

2. x-cmd 提供1分钟教程，其中包含了 mermaid-cli 命令常用功能的 demo 示例，可以帮你快速上手 mermaid-cli 。

3. 使用案例:

   

   # 安装 mermaid-cli
   x env use mermaid-cli
   
   # 使用 mermaid 语法文件生成 png 文件
   mmdc -i input.mmd -o output.png
   
   # 创建具有深色主题和透明背景的 PNG
   mmdc -i input.mmd -o output.png -t dark -b transparent
   
   # 使用标准输入传入 mermaid 语法描述文本并生成 svg 文件
   cat input.mmd | mmdc -i - -o output.svg
   

功能特点

1. 多种格式输出: 支持 SVG / PNG / PDF 格式输出。同时也支持将 markdown 文件中的 Mermaid 语法文本转换为图片引用的方式。
2. 自定义样式: 用户可自定义 CSS 配置文件，以自定义输出图片中图表的样式。
3. stdin 管道支持: 支持通过管道的方式将 Mermaid 语法文本传递给 mermaid-cli，让用户在终端环境中可以便捷进行处理或转换。

竞品和相关作品

1. dot: 由 Graphviz （使用 DOT 语言来以简单的方式描述图形的可视化工具）官方提供的命令行工具，可以用于生成各种复杂的图形。它还提供了多种选项，可用于控制图形的样式和布局。

• drawio: draw.io 是一个开源的在线和桌面绘图工具，用于创建各种图表和流程图。其界面直观易用，适合各种用户。它提供了丰富的图形元素和样式，可用于创建专业的图表。同时在客户端软件安装包中也提供了命令行工具，提供给用户进行批量图形处理。

进一步探索

• mermaid-cli - GitHub
• Mermaid - 官网