这是美人鱼的命令行接口(CLI)。它将美人鱼定义文件作为输入,并生成SVG/PNG/PDF文件作为输出。
npm install -g @mermaid-js/mermaid-cli
将美人鱼MMD图文件转换为SVG
mmdc -i input.mmd -o output.svg
笔记
如果您不想在全球安装软件包,请参见替代安装。
找到如何调用您首选方法的MMDC可执行文件,即Docker,Yarn,NPM,本地安装等。
mmdc -i input.mmd -o output.png -t dark -b transparent
--cssFile
选项可用于内联一些自定义CSS。
有关具有动画的CSS文件的示例,请参见./test-posive/flowchart1.css。
警告:如果您想覆盖mermaid
的themeCSS
,我们建议您将{"themeCSS": "..."})
添加到您的美人鱼--configFile
。您可能需要使用!important
是覆盖Mermiad的themeCSS
。
警告:内联CSS文件可能会被您的浏览器阻止,具体取决于托管您的SVG的网站的HTTP Content-security-Policy标头。
mmdc --input test-positive/flowchart1.mmd --cssFile test-positive/flowchart1.css -o docs/animated-flowchart.svg
mmdc -i readme.template.md -o readme.md
此命令将转换降价文件本身。 Mermaid-CLI将找到美人鱼图,从它们创建SVG文件,并参考Markdown输出中的文件。
这:
### Some markdown
``` mermaid
graph
[....]
```
### Some more markdown
``` mermaid
sequenceDiagram
[....]
```
### Mermaid with custom title/desc
``` mermaid
graph
accTitle: My title here
accDescr: My description here
A-->B
```
变成:
### Some markdown
![ diagram ] ( ./readme-1.svg )
### Some more markdown
![ diagram ] ( ./readme-2.svg )
### Mermaid with custom title/desc
![ My description here ] ( ./readme-3.svg " My title here ")
您可以轻松地从STDIN输入输入。此示例显示了如何使用Heredoc将stdin的图发送给Mermaid-CLI(MMDC)。
cat << EOF | mmdc --input -
graph TD
A[Client] --> B[Load Balancer]
EOF
mmdc -h
docker pull minlag/mermaid-cli
或从github容器注册表中拉
docker pull ghcr.io/mermaid-js/mermaid-cli/mermaid-cli
或例如版本8.8.0
docker pull minlag/mermaid-cli:8.8.0
该容器在/data
中查找输入文件。因此,例如,如果您在/path/to/diagrams/diagram.mmd
中的系统上定义了一个图,则可以使用容器来生成SVG文件,如下所示:
docker run --rm -u ` id -u ` : ` id -g ` -v /path/to/diagrams:/data minlag/mermaid-cli -i diagram.mmd
或者,如果使用Podman,则可以:
podman run --userns keep-id --user ${UID} --rm -v /path/to/diagrams:/data:z ghcr.io/mermaid-js/mermaid-cli/mermaid-cli -i diagram.mmd
Podman命令与Docker命令的关键差异是:
--userns keep-id
论点的添加。这允许容器在容器名称空间中保持与当前用户的UID相同的UID,而不是映射到子图。文档可以在这里找到:z
到卷映射的末端。这指示Podman使用SELINUX标签container_file_t
重新标记卷中的文件,该文件允许容器中的进程访问文件。有关更多信息,请参见此处的“标记音量安装座”部分。在以前的版本中,输入文件安装在/home/mermaidcli
中。您可以使用--workdir
选项来还原此行为:
docker run [...] --workdir=/home/mermaidcli minlag/mermaid-cli [...]
可以通过node.js api致电mermaid-cli
。请注意, nodejs API未涵盖SEMVER ,因为mermaid-cli
遵循mermaid
的版本操作。
import { run } from "@mermaid-js/mermaid-cli"
await run (
"input.mmd" , "output.svg" , // {optional options},
)
有些人在全球安装此工具时遇到问题。在本地安装它是一种替代解决方案:
npm install @mermaid-js/mermaid-cli
./node_modules/.bin/mmdc -h
或使用NPM:
npm install @mermaid-js/mermaid-cli
./node_modules/.bin/mmdc -h
npx
默认使用NPM安装。它同时下载并运行命令。要将Mermaid CLI与NPX一起使用,您需要使用-p
标志,因为软件包名称与安装命令( mmdc
)不同。 npx -p @mermaid-js/mermaid-cli mmdc -h
警告
这种安装方法不再支持。有关更多详细信息,请参阅讨论。可以与酿造一起安装旧版本的Mermaid-CLI。
brew install mermaid-cli
欢迎捐款。请参阅贡献指南。