mermaid

项目地址

GitHub - mermaid-js/mermaid: Generation of diagram and flowchart from text in a similar manner as markdownGitHub

官方文档

mermaid - Markdownish syntax for generating flowcharts, sequence diagrams, class diagrams, gantt charts and git graphs.

在线编辑器

Online FlowChart & Diagrams Editor - Mermaid Live Editor

示例

流程图

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

显示效果：

流程图

序列图

sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop Healthcheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail!
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!

显示效果：

序列图

甘特图

gantt
dateFormat  YYYY-MM-DD
title Adding GANTT diagram to mermaid
excludes weekdays 2014-01-10

section A section
Completed task            :done,    des1, 2014-01-06,2014-01-08
Active task               :active,  des2, 2014-01-09, 3d
Future task               :         des3, after des2, 5d
Future task2               :         des4, after des3, 5d

显示效果：

甘特图

类图（实验性）

classDiagram
Class01 <|-- AveryLongClass : Cool
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 --> C2 : Where am i?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
Class08 <--> C2: Cool label

显示效果：

类图

Git分支图（实验性）

gitGraph:
options
{
    "nodeSpacing": 150,
    "nodeRadius": 10
}
end
commit
branch newbranch
checkout newbranch
commit
commit
checkout master
commit
commit
merge newbranch

显示效果：

GIt分支图

VSCode插件

https://marketplace.visualstudio.com/items?itemName=vstirbu.vscode-mermaid-previewmarketplace.visualstudio.com