minlag/mermaid-cli

镜像概述

mermaid-cli Docker镜像是mermaid命令行工具（mermaid-cli）的官方容器化版本。mermaid-cli是一款用于将mermaid图表定义文件（.mmd）转换为可视化图像文件（如PNG、SVG、PDF等）的工具，支持流程图、时序图、类图、状态图等多种图表类型。该镜像由mermaid官方维护，每次GitHub仓库（https://github.com/mermaid-js/mermaid-cli%EF%BC%89%E6%9C%89%E4%BB%A3%E7%A0%81%E5%8F%98%E6%9B%B4%E6%97%B6%E4%BC%9A%E8%87%AA%E5%8A%A8%E9%87%8D%E5%BB%BA%EF%BC%8C%E7%A1%AE%E4%BF%9D%E4%B8%8E%E6%9C%80%E6%96%B0%E7%89%88%E6%9C%AC%E7%9A%84mermaid-cli%E5%90%8C%E6%AD%A5%E3%80%82

核心功能与特性

• 官方维护：作为mermaid-cli的官方镜像，确保与上游工具版本同步，提供可靠的图表转换能力。
• 多图表类型支持：兼容mermaid语法定义的所有图表类型，包括流程图（graph）、时序图（sequenceDiagram）、类图（classDiagram）、状态图（stateDiagram）、甘特图（gantt）等。
• 多输出格式：支持生成PNG、SVG、PDF、JPEG等多种图像格式，满足不同场景的文档需求。
• 自动更新：基于GitHub仓库代码变更自动触发镜像重建，确保用户获取最新功能和修复。

使用场景

• CI/CD流程集成：在持续集成/部署流程中自动将文档中的mermaid图表定义转换为图像，嵌入到生成的文档中（如API文档、用户手册）。
• 开发环境快速预览：开发者无需本地安装mermaid-cli，通过容器快速将mermaid文件转换为图像，预览图表效果。
• 服务器端批量处理：在服务器环境中批量转换大量mermaid文件，适用于文档系统或图表管理平台。

使用方法与配置说明

基本用法

通过docker run命令运行容器，挂载包含mermaid文件的目录，并指定输入文件和输出路径。

示例：转换单个mermaid文件

将当前目录下的input.mmd（mermaid图表定义文件）转换为output.png：

bash
docker run --rm -v $(pwd):/data mermaid/mermaid-cli input.mmd -o output.png

• --rm：容器退出后自动删除，避免残留容器。
• -v $(pwd):/data：将当前目录挂载到容器内的/data目录，使容器可访问输入文件并输出结果到本地。
• input.mmd：输入的mermaid定义文件（路径相对于容器内的/data目录，即本地挂载目录）。
• -o output.png：指定输出文件路径（相对于容器内的/data目录，即输出到本地当前目录）。

常用参数说明

mermaid-cli支持多种参数自定义转换行为，部分常用参数如下：

批量转换示例

转换目录下所有.mmd文件为SVG格式：

bash
docker run --rm -v $(pwd):/data mermaid/mermaid-cli *.mmd -f svg -o output_dir/

错误反馈

若使用镜像时遇到错误或问题，请通过GitHub Issues页面提交反馈：https://github.com/mermaid-js/mermaid-cli/issues