這是美人魚的命令行接口(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
歡迎捐款。請參閱貢獻指南。