lyceum-site/content/docs/shortcodes/mermaid.md

46 lines
1.1 KiB
Markdown
Raw Normal View History

2024-10-03 22:08:11 +00:00
# Mermaid Chart
[MermaidJS](https://mermaid-js.github.io/) is library for generating svg charts and diagrams from text.
{{< hint info >}}
**Override Mermaid Initialization Config**
To override the [initialization config](https://mermaid-js.github.io/mermaid/#/Setup) for Mermaid,
create a `mermaid.json` file in your `assets` folder!
{{< /hint >}}
## Example
<div class="book-columns flex flex-wrap">
<div class="flex-even markdown-inner">
```tpl
{{</* mermaid class="optional" >}}
stateDiagram-v2
State1: The state with a note
note right of State1
Important information! You can write
notes.
end note
State1 --> State2
note left of State2 : This is the note to the left.
{{< /mermaid */>}}
```
</div>
<div class="flex-even markdown-inner">
{{< mermaid class="optional" >}}
stateDiagram-v2
State1: The state with a note
note right of State1
Important information! You can write
notes.
end note
State1 --> State2
note left of State2 : This is the note to the left.
{{< /mermaid >}}
</div>
</div>