jnewland/mermaid.cli

mermaid.cli镜像说明

镜像概述

本镜像提供了https://mermaidjs.github.io/%E7%9A%84%E5%91%BD%E4%BB%A4%E8%A1%8C%E7%95%8C%E9%9D%A2%E5%B7%A5%E5%85%B7%EF%BC%88mermaid.cli%EF%BC%89%EF%BC%8C%E7%94%A8%E4%BA%8E%E5%B0%86mermaid%E5%9B%BE%E8%A1%A8%E5%AE%9A%E4%B9%89%E6%96%87%E4%BB%B6%EF%BC%88.mmd%EF%BC%89%E8%BD%AC%E6%8D%A2%E4%B8%BASVG%E3%80%81PNG%E6%88%96PDF%E6%A0%BC%E5%BC%8F%E7%9A%84%E5%8F%AF%E8%A7%86%E5%8C%96%E5%9B%BE%E8%A1%A8%EF%BC%8C%E6%94%AF%E6%8C%81%E8%87%AA%E5%AE%9A%E4%B9%89%E6%A0%B7%E5%BC%8F%E5%92%8C%E5%B0%BA%E5%AF%B8%EF%BC%8C%E6%96%B9%E4%BE%BF%E9%9B%86%E6%88%90%E5%88%B0%E6%96%87%E6%A1%A3%E6%88%96%E8%87%AA%E5%8A%A8%E5%8C%96%E6%B5%81%E7%A8%8B%E4%B8%AD%E3%80%82

核心功能

• 多格式输出：支持SVG、PNG、PDF三种可视化格式
• 主题自定义：提供default/forest/dark/neutral四种主题选择
• 尺寸调整：可设置输出宽度、高度
• 背景配置：支持透明、颜色名称或十六进制值的背景色
• 样式扩展：允许通过配置文件和CSS文件自定义图表样式

使用场景

• 技术文档：插入流程图、时序图、类图等可视化内容
• 自动化流程：CI/CD中批量生成图表
• 快速可视化：将mermaid文本定义转换为直观图表

配置说明

Docker部署示例

基本SVG转换

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

生成PNG格式

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

自定义主题与背景

bash
docker run --rm -v $(pwd):/data docker.xuanyuan.run/jnewland/mermaid.cli -i /data/input.mmd -o /data/output.png -t forest -b '#F0F0F0'

参数选项

查看最新参数：

bash
docker run --rm docker.xuanyuan.run/jnewland/mermaid.cli -h

常用参数参考：

• -i, --input <input>：必填，输入的mermaid文件路径（容器内路径，需卷映射本地文件）
• -o, --output [output]：输出文件路径，默认输入文件名+SVG格式
• -t, --theme [name]：图表主题，默认default
• -w, --width [width]：输出宽度，默认800
• -H, --height [height]：输出高度，默认600
• -b, --backgroundColor [color]：背景色，默认white
• -c, --configFile [config]：mermaid配置文件路径
• -C, --cssFile [cssFile]：自定义CSS文件路径