diff options
| author | aethrvmn <me@aethrvmn.gr> | 2025-08-30 13:17:32 +0000 |
|---|---|---|
| committer | aethrvmn <me@aethrvmn.gr> | 2025-08-30 13:17:32 +0000 |
| commit | 1147a663e70aadb2578cbe601bc723d7cd939c5a (patch) | |
| tree | b5100d2031328be3cfd3e9ae62730436bd573e0f /themes/hugo-book/exampleSite/content.en/docs/shortcodes/mermaid.md | |
| parent | added .gitignore (diff) | |
added non-content
Diffstat (limited to 'themes/hugo-book/exampleSite/content.en/docs/shortcodes/mermaid.md')
| -rw-r--r-- | themes/hugo-book/exampleSite/content.en/docs/shortcodes/mermaid.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/themes/hugo-book/exampleSite/content.en/docs/shortcodes/mermaid.md b/themes/hugo-book/exampleSite/content.en/docs/shortcodes/mermaid.md new file mode 100644 index 0000000..10fe06a --- /dev/null +++ b/themes/hugo-book/exampleSite/content.en/docs/shortcodes/mermaid.md @@ -0,0 +1,42 @@ +# 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 + + +{{% columns %}} + +```tpl +{{</* mermaid [class="..."] >}} +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 */>}} +``` + +<---> + +{{<mermaid>}} +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>}} + +{{% /columns %}} |
