davebarfoot/mermaid

mermaid-cli Docker镜像

镜像概述和主要用途

本镜像为基于https://github.com/mermaid-js/mermaid-cli Dockerfile的未修改构建版本。主要用于解决官方mermaid-cli镜像存在的两个问题：每次运行时出现的yarn许可证错误，以及绑定挂载目录时需在mmdc参数中显式指定/data路径的问题。通过本镜像，用户可更便捷地使用mermaid-cli生成流程图、时序图等各类图表。

核心功能和特性

• 未修改构建：严格基于mermaid-cli官方Dockerfile构建，未做额外修改，确保与官方功能一致性
• 解决许可证错误：修复官方镜像每次运行时出现的yarn许可证错误问题
• 简化挂载使用：绑定挂载当前目录到/data时，无需在mmdc参数中额外指定/data路径，使用更便捷

使用场景和适用范围

适用于需要通过mermaid-cli将mermaid语法文件（.mmd）转换为图片（如PNG、SVG等）的场景，包括但不限于：

• 开发人员生成项目流程图、架构图
• 文档编写者为技术文档添加可视化图表
• CI/CD流程中自动生成图表并集成到文档或报告中

使用方法和配置说明

基本使用命令

通过以下命令运行镜像，将当前目录挂载到容器的/data目录，直接使用mmdc命令处理当前目录下的mermaid文件：

bash
docker run --rm -v "$PWD":/data docker.xuanyuan.run/davebarfoot/mermaid:latest

参数说明

• --rm：容器退出后自动删除容器
• -v "$PWD":/data：将当前工作目录（$PWD）绑定挂载到容器内的/data目录，使容器可访问本地mermaid文件
• davebarfoot/mermaid:latest：镜像名称及标签

使用示例

假设当前目录下有mermaid文件diagram.mmd，运行以下命令生成PNG格式图表：

bash
docker run --rm -v "$PWD":/data docker.xuanyuan.run/davebarfoot/mermaid:latest mmdc -i diagram.mmd -o output.png

此命令会读取当前目录的diagram.mmd文件，生成output.png图片并保存到当前目录。