81 lines
1.5 KiB
Markdown
81 lines
1.5 KiB
Markdown
---
|
|
title: Mermaid
|
|
---
|
|
|
|
[Mermaid](https://mermaidjs.github.io/) is library for generating SVG charts and diagrams from text.
|
|
|
|
## Usage
|
|
|
|
<!-- prettier-ignore -->
|
|
```tpl
|
|
{{</* mermaid class="text-center" */>}}
|
|
sequenceDiagram
|
|
Alice->>Bob: Hello Bob, how are you?
|
|
alt is sick
|
|
Bob->>Alice: Not so good :(
|
|
else is well
|
|
Bob->>Alice: Feeling fresh like a daisy
|
|
end
|
|
opt Extra response
|
|
Bob->>Alice: Thanks for asking
|
|
end
|
|
{{</* /mermaid */>}}
|
|
```
|
|
|
|
### Attributes
|
|
|
|
<!-- prettier-ignore-start -->
|
|
<!-- spellchecker-disable -->
|
|
{{< propertylist name=shortcode-mermaid sort=name order=asc >}}
|
|
<!-- spellchecker-enable -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
## Example
|
|
|
|
<!-- spellchecker-disable -->
|
|
<!-- prettier-ignore -->
|
|
{{< mermaid class="text-center" >}}
|
|
sequenceDiagram
|
|
Alice->>Bob: Hello Bob, how are you?
|
|
alt is sick
|
|
Bob->>Alice: Not so good :(
|
|
else is well
|
|
Bob->>Alice: Feeling fresh like a daisy
|
|
end
|
|
opt Extra response
|
|
Bob->>Alice: Thanks for asking
|
|
end
|
|
{{< /mermaid >}}
|
|
|
|
<!-- spellchecker-enable -->
|
|
|
|
As an alternative to shortcodes, code blocks can be used for markdown as well.
|
|
|
|
{{< columns >}}
|
|
|
|
<!-- prettier-ignore -->
|
|
````tpl
|
|
```mermaid
|
|
flowchart LR
|
|
A[Hard] -->|Text| B(Round)
|
|
B --> C{Decision}
|
|
C -->|One| D[Result 1]
|
|
C -->|Two| E[Result 2]
|
|
```
|
|
````
|
|
|
|
<--->
|
|
|
|
<!-- spellchecker-disable -->
|
|
<!-- prettier-ignore -->
|
|
```mermaid
|
|
flowchart LR
|
|
A[Hard] -->|Text| B(Round)
|
|
B --> C{Decision}
|
|
C -->|One| D[Result 1]
|
|
C -->|Two| E[Result 2]
|
|
```
|
|
|
|
<!-- spellchecker-enable -->
|
|
|
|
{{< /columns >}}
|