Flow chart
+Syntax
https://mermaid-js.github.io/mermaid/#/flowchart
...
| Code Block |
|---|
graph TB
c1-->a2
subgraph one
a1-->a2
end
subgraph two
b1-->b2
end
subgraph three
c1-->c2
end |
+ Display
| Mermaid | ||||||
|---|---|---|---|---|---|---|
| ||||||
{"diagramDefinition":"graph TB\n c1-->a2 \n subgraph one\n a1-->a2\n end \n subgraph two\n b1-->b2 \n end\n subgraph three\n c1-->c2\n end"} |
+ Markdown
| Code Block |
|---|
graph TD
A[Inactive device]:::danger -->|Remove battery<br>strip/paper| B[Active device]:::good
B --> C[Install/Stick at the desired place]
C --> D[Open the Super Awsome app]
D --> E[In the great tab, find the newly discovered device]
E --> F[Check if the ID matches the ID printed on the device]
F -->|If match| G[Rename the device with its location]
F -->|If no match| H[Check for another newly discovered device in the app]
G --> I["Check that the status of the device is #quot;Ok#quot;"]
I --> J[You're good to<br>go]:::good
classDef danger fill:red,color:white;
classDef good fill:green,color:white; |
+ Display
| Mermaid |
|---|
graph TD A[Inactive device]:::danger -->|Remove battery<br>strip/paper| B[Active device]:::good B --> C[Install/Stick at the desired place] C --> D[Open the Super Awsome app] D --> E[In the great tab, find the newly discovered device] E --> F[Check if the ID matches the ID printed on the device] F -->|If match| G[Rename the device with its location] F -->|If no match| H[Check for another newly discovered device in the app] G --> I["Check that the status of the device is #quot;Ok#quot;"] I --> J[You're good to<br>go]:::good classDef danger fill:red,color:white; classDef good fill:green,color:white; |
Sequence diagram
+ Syntax
https://mermaid-js.github.io/mermaid/#/sequenceDiagram
+ Markdown
| Code Block |
|---|
sequenceDiagram
autonumber
Alice->>John: Hello John, how are you?
loop Healthcheck
John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good! |
+ Display
| Mermaid | ||
|---|---|---|
| ||
sequenceDiagram autonumber Alice->>John: Hello John, how are you? loop Healthcheck John->>John: Fight against hypochondria end Note right of John: Rational thoughts! John-->>Alice: Great! John->>Bob: How about you? Bob-->>John: Jolly good! |
Class diagram
+ Syntax
https://mermaid-js.github.io/mermaid/#/classDiagram
+ Markdown
| Code Block |
|---|
classDiagram
Animal <|-- Duck
Animal <|-- Fish
Animal <|-- Zebra
Animal : +int age
Animal : +String gender
Animal: +isMammal()
Animal: +mate()
class Duck{
+String beakColor
+swim()
+quack()
}
class Fish{
-int sizeInFeet
-canEat()
}
class Zebra{
+bool is_wild
+run()
} |
+ Display
| Mermaid |
|---|
classDiagram
Animal <|-- Duck
Animal <|-- Fish
Animal <|-- Zebra
Animal : +int age
Animal : +String gender
Animal: +isMammal()
Animal: +mate()
class Duck{
+String beakColor
+swim()
+quack()
}
class Fish{
-int sizeInFeet
-canEat()
}
class Zebra{
+bool is_wild
+run()
} |
State Diagram
+ Syntax
https://mermaid-js.github.io/mermaid/#/stateDiagram
+ Markdown
| Code Block |
|---|
stateDiagram-v2
[*] --> Still
Still --> [*]
Still --> Moving
Moving --> Still
Moving --> Crash
Crash --> [*] |
+ Display
| Mermaid | ||
|---|---|---|
| ||
stateDiagram-v2
[*] --> Still
Still --> [*]
Still --> Moving
Moving --> Still
Moving --> Crash
Crash --> [*] |
Entity Relationship Diagrams
+ Syntax
https://mermaid-js.github.io/mermaid/#/entityRelationshipDiagram
+ Markdown
| Code Block |
|---|
erDiagram
CUSTOMER ||--o{ ORDER : places
ORDER ||--|{ LINE-ITEM : contains
CUSTOMER }|..|{ DELIVERY-ADDRESS : uses |
+ Display
| Mermaid |
|---|
erDiagram
CUSTOMER ||--o{ ORDER : places
ORDER ||--|{ LINE-ITEM : contains
CUSTOMER }|..|{ DELIVERY-ADDRESS : uses |
User Journey Diagram
+ Syntax
https://mermaid-js.github.io/mermaid/#/user-journey
+ Markdown
| Code Block |
|---|
journey
title My working day
section Go to work
Make tea: 5: Me
Go upstairs: 3: Me
Do work: 1: Me, Cat
section Go home
Go downstairs: 5: Me
Sit down: 5: Me |
+ Display
| Mermaid |
|---|
journey
title My working day
section Go to work
Make tea: 5: Me
Go upstairs: 3: Me
Do work: 1: Me, Cat
section Go home
Go downstairs: 5: Me
Sit down: 5: Me |
Gantt diagram
+ Syntax
https://mermaid-js.github.io/mermaid/#/gantt
+ Markdown
| Code Block |
|---|
gantt
title A Gantt Diagram
dateFormat YYYY-MM-DD
section Section
A task :a1, 2014-01-01, 30d
Another task :after a1 , 20d
section Another
Task in sec :2014-01-12 , 12d
another task : 24d |
+ Display
| Mermaid |
|---|
gantt
title A Gantt Diagram
dateFormat YYYY-MM-DD
section Section
A task :a1, 2014-01-01, 30d
Another task :after a1 , 20d
section Another
Task in sec :2014-01-12 , 12d
another task : 24d |
Pie chart
+ Syntax
https://mermaid-js.github.io/mermaid/#/pie
+ Markdown
| Code Block |
|---|
pie title Pets adopted by volunteers
"Dogs" : 386
"Cats" : 85
"Rats" : 15 |
+ Display
| Mermaid |
|---|
pie title Pets adopted by volunteers
"Dogs" : 386
"Cats" : 85
"Rats" : 15 |