文本制图语法 Mermaid todo

文档用于

介绍文本制图语法 Mermaid.

简介

INFO

详见 Mermaid 官方文档.

flowchart LR
    A --> B

配置

INFO

Mermaid Json Schema.

命令行

TIP

mermaid 命令行工具适用范围最广, 在缺少 mermaid 语法原生支持的地方依然可以用.
并且 mermaid 命令行工具总是支持最新的语法 (只要把命令行工具更新到最新版本).

如果经常使用 mermaid-cli, 可以考虑全局安装在本地设备中:

pnpm install -g @mermaid-js/mermaid-cli

通过 .mmd 文件生成暗色主题透明背景的图片:
通过 -i 指定源文件路径, 通过 -o 指定输出文件 路径 和 类型.

mmdc -i input.mmd -o output.png -t dark -b transparent

TIP

建议在 .mmd 源文件中通过注释记录 "将此文件转为图片的命令". 注释使用 %% 开头.

如果不通过 -o 指定输出路径, 则会在同级目录生成同名 svg 文件:
假设源文件名为 input.mmd, 那么输出的文件则名为 input.mmd.svg.

mmdc -i input.mmd -b transparent

VS Code

以下两个插件分别用于 实时预览 和 语法高亮.

笔记

换行

mermaid 支持用转义字符 \n 来换行.