227 lines
6.0 KiB
Markdown
227 lines
6.0 KiB
Markdown
|
+++
|
||
|
|
description = "Generation of diagram and flowchart from text in a similar manner as Markdown"
|
||
|
|
title = "Mermaid"
|
||
|
|
+++
|
||
|
|
|
||
|
|
[Mermaid](https://mermaidjs.github.io/) is a library helping you to generate diagram and flowcharts from text, in a similar manner as Markdown.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Just insert your Mermaid code in the `mermaid` shortcode like this:
|
||
|
|
|
||
|
|
````go
|
||
|
|
{{</* mermaid [ align=(left|right|center|justify) ] */>}}
|
||
|
|
classDiagram
|
||
|
|
Person *-- Dog
|
||
|
|
{{</* /mermaid */>}}
|
||
|
|
````
|
||
|
|
|
||
|
|
You can set an optional `align` attribute which defaults to `center`.
|
||
|
|
|
||
|
|
If you don't need alignment you can use the alternative syntax using code fences if you have turned off `guessSyntax` for the `markup.highlight` setting (see below):
|
||
|
|
|
||
|
|
````plaintext
|
||
|
|
```mermaid
|
||
|
|
classDiagram
|
||
|
|
Person *-- Dog
|
||
|
|
```
|
||
|
|
````
|
||
|
|
|
||
|
|
The generated graphs can be be panned by dragging them and zoomed by using the mousewheel. On mobile devices you can use finger gestures.
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
### Flowchart
|
||
|
|
|
||
|
|
{{< mermaid align="left" >}}
|
||
|
|
graph LR;
|
||
|
|
A[Hard edge] -->|Link text| B(Round edge)
|
||
|
|
B --> C{<strong>Decision</strong>}
|
||
|
|
C -->|One| D[Result one]
|
||
|
|
C -->|Two| E[Result two]
|
||
|
|
{{< /mermaid >}}
|
||
|
|
|
||
|
|
{{% expand "Show markup" "true" %}}
|
||
|
|
````go
|
||
|
|
{{</* mermaid align="left" */>}}
|
||
|
|
graph LR;
|
||
|
|
A[Hard edge] -->|Link text| B(Round edge)
|
||
|
|
B --> C{<strong>Decision</strong>}
|
||
|
|
C -->|One| D[Result one]
|
||
|
|
C -->|Two| E[Result two]
|
||
|
|
{{</* /mermaid */>}}
|
||
|
|
````
|
||
|
|
{{% /expand %}}
|
||
|
|
|
||
|
|
### Sequence
|
||
|
|
|
||
|
|
{{< 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 "Show markup" "true" %}}
|
||
|
|
````go
|
||
|
|
{{</* 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 %}}
|
||
|
|
|
||
|
|
### GANTT
|
||
|
|
|
||
|
|
{{< 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 "Show markup" "true" %}}
|
||
|
|
````go
|
||
|
|
{{</* 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 %}}
|
||
|
|
|
||
|
|
### Class
|
||
|
|
|
||
|
|
{{< mermaid >}}
|
||
|
|
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
|
||
|
|
{{< /mermaid >}}
|
||
|
|
|
||
|
|
{{% expand "Show markup" "true" %}}
|
||
|
|
````go
|
||
|
|
{{</* mermaid */>}}
|
||
|
|
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
|
||
|
|
{{</* /mermaid */>}}
|
||
|
|
````
|
||
|
|
{{% /expand %}}
|
||
|
|
|
||
|
|
### State
|
||
|
|
|
||
|
|
````mermaid
|
||
|
|
stateDiagram-v2
|
||
|
|
open: Open Door
|
||
|
|
closed: Closed Door
|
||
|
|
locked: Locked Door
|
||
|
|
open --> closed: Close
|
||
|
|
closed --> locked: Lock
|
||
|
|
locked --> closed: Unlock
|
||
|
|
closed --> open: Open
|
||
|
|
````
|
||
|
|
|
||
|
|
{{% expand "Show markup" "true" %}}
|
||
|
|
````go
|
||
|
|
```mermaid
|
||
|
|
stateDiagram-v2
|
||
|
|
open: Open Door
|
||
|
|
closed: Closed Door
|
||
|
|
locked: Locked Door
|
||
|
|
open --> closed: Close
|
||
|
|
closed --> locked: Lock
|
||
|
|
locked --> closed: Unlock
|
||
|
|
closed --> open: Open
|
||
|
|
```
|
||
|
|
````
|
||
|
|
{{% /expand %}}
|
||
|
|
|
||
|
|
## Configuration
|
||
|
|
|
||
|
|
Mermaid is configured with default settings. You can customize Mermaid's default settings for all of your files thru a JSON object in your `config.toml` or override these settings sidewise thru your pages frontmatter.
|
||
|
|
|
||
|
|
This JSON object is forwarded into Mermaid's `mermaid.initialize()` function.
|
||
|
|
|
||
|
|
See [Mermaid documentation](http://mermaid-js.github.io/mermaid/getting-started/Setup.html#mermaidapi-configuration-defaults) for all allowed settings.
|
||
|
|
|
||
|
|
Also, if you want to use mermaid codefences, you have to turn off `guessSyntax` for the `markup.highlight` setting.
|
||
|
|
|
||
|
|
### Example
|
||
|
|
|
||
|
|
````toml
|
||
|
|
[params]
|
||
|
|
mermaidInitialize = "{ \"theme\": \"dark\" }"
|
||
|
|
|
||
|
|
[markup]
|
||
|
|
[markup.highlight]
|
||
|
|
guessSyntax = false # if set to true, avoid unstyled code if no language was given but mermaid code fences will not work anymore
|
||
|
|
````
|
||
|
|
|
||
|
|
or pages frontmatter
|
||
|
|
````toml
|
||
|
|
+++
|
||
|
|
mermaidInitialize = "{ \"theme\": \"dark\" }"
|
||
|
|
+++
|
||
|
|
````
|