1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
---
description: Mermaid is a tool that generates diagrams and charts, from markdown-inspired
text definitions
title: mermaid
---
## Flowchart example
{{%expand "Show code ..."%}}
```
{{</*mermaid align="left"*/>}}
graph LR;
A[Hard edge] -->|Link text| B(Round edge)
B --> C{Decision}
C -->|One| D[Result one]
C -->|Two| E[Result two]
{{</* /mermaid */>}}
```
{{%/expand%}}
{{<mermaid align="left">}}
graph LR;
A[Hard edge] -->|Link text| B(Round edge)
B --> C{Decision}
C -->|One| D[Result one]
C -->|Two| E[Result two]
{{< /mermaid >}}
### With sub-graphs and some style
{{%expand "Show code..."%}}
```
{{</*mermaid align="left"*/>}}
graph LR;
X --> Y
linkStyle 0 stroke:#f00,stroke-width:4px;
Y --> Z
Z --> X
linkStyle 1,2 interpolate basis stroke:#0f0,stroke-width:2px;
X --> A1
subgraph right
A2 --> B2
B2 --> C2
end
subgraph left
A1 --> B1
B1 --> C1
end
C1 --> X
Z --> A2
C2 --> Z
style Y fill:#f9f,stroke:#333,stroke-width:4px
classDef left fill:#ccf,stroke:#f66,stroke-width:2px,stroke-dasharray: 5, 5
class A1,B1,C1 left
{{</* /mermaid */>}}
```
{{%/expand%}}
{{<mermaid align="left">}}
graph LR;
X --> Y
linkStyle 0 stroke:#f00,stroke-width:4px;
Y --> Z
Z --> X
X --> A1
subgraph right
A2 --> B2
B2 --> C2
end
subgraph left
A1 --> B1
B1 --> C1
end
C1 --> X
Z --> A2
C2 --> Z
style Y fill:#f9f,stroke:#333,stroke-width:4px
classDef left fill:#ccf,stroke:#f66,stroke-width:2px,stroke-dasharray: 5, 5
class A1,B1,C1 left
{{</mermaid>}}
## Sequence example
{{%expand "Show code ..."%}}
```
{{</*mermaid*/>}}
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!
{{</* /mermaid */>}}
```
{{%/expand%}}
{{<mermaid>}}
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!
{{< /mermaid >}}
## GANTT Example
{{%expand "Show code ..."%}}
```
{{</*mermaid*/>}}
gantt
dateFormat YYYY-MM-DD
title Adding GANTT diagram functionality to mermaid
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
section Critical tasks
Completed task in the critical line :crit, done, 2014-01-06,24h
Implement parser and jison :crit, done, after des1, 2d
Create tests for parser :crit, active, 3d
Future task in critical line :crit, 5d
Create tests for renderer :2d
Add to mermaid :1d
{{</* /mermaid */>}}
```
{{%/expand%}}
{{<mermaid>}}
gantt
dateFormat YYYY-MM-DD
title Adding GANTT diagram functionality to mermaid
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
section Critical tasks
Completed task in the critical line :crit, done, 2014-01-06,24h
Implement parser and jison :crit, done, after des1, 2d
Create tests for parser :crit, active, 3d
Future task in critical line :crit, 5d
Create tests for renderer :2d
Add to mermaid :1d
{{</mermaid>}}
|
