phinze/mermaid

mermaid-docker

镜像概述

mermaid-docker是mermaid图表工具的Docker打包版本，旨在提供一种无需配置npm环境即可使用mermaid的便捷方式。通过该镜像，用户可以直接运行mermaid命令生成流程图、时序图、类图等各类图表，避免了本地安装npm及相关依赖的繁琐过程。

核心功能与特性

• 无需npm依赖：无需在本地安装Node.js或npm，通过Docker容器即可直接使用mermaid
• 简化使用流程：省去环境配置步骤，直接通过容器命令执行mermaid操作
• 与mermaid原生功能一致：支持mermaid所有图表类型及语法，保持工具原有功能完整性

使用场景

• 本地开发环境中快速生成mermaid图表，无需配置Node.js环境
• CI/CD流程中集成图表生成步骤，自动化生成文档所需图表
• 临时或一次性图表生成需求，避免本地环境污染

使用方法

基本使用

通过docker run命令直接运行容器，执行mermaid命令。基本格式如下：

bash
docker run --rm -v $(pwd):/data mermaid-docker mermaid [mermaid命令参数]

参数说明

• --rm：容器运行结束后自动删除
• -v $(pwd):/data：将当前目录挂载到容器内的/data目录，用于读取输入文件和输出结果
• mermaid [参数]：mermaid工具的原生命令及参数（可通过mermaid --help查看所有参数）

示例

1. 生成PNG格式图表

将当前目录下的diagram.mmd文件转换为PNG格式图片：

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

2. 查看mermaid帮助信息

bash
docker run --rm mermaid-docker mermaid --help

3. 生成SVG格式图表并指定输出目录

bash
docker run --rm -v $(pwd):/data mermaid-docker mermaid -i input.mmd -o /data/outputs/ -t svg

注意事项

• 确保输入的mermaid文件路径相对于挂载的/data目录（即当前目录）
• 输出文件会保存在挂载目录中，需确保本地目录有写入权限
• 支持mermaid所有原生命令参数，具体可参考mermaid官方文档