diff options
| author | aethrvmn <me@aethrvmn.gr> | 2025-09-20 22:27:35 +0000 |
|---|---|---|
| committer | aethrvmn <me@aethrvmn.gr> | 2025-09-20 22:27:35 +0000 |
| commit | 9b5f3fad7068298265dbbc8a65077f7917a090a5 (patch) | |
| tree | 0905b29eb7c03d6bc6e16dd1ebcd1ec9b6b83320 /themes/hugo-book/exampleSite/content.en/docs/shortcodes/mermaid.md | |
| parent | super simple setup guide (diff) | |
updated hugo-book theme
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 | 156 |
1 files changed, 154 insertions, 2 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 index 10fe06a..bc40fab 100644 --- a/themes/hugo-book/exampleSite/content.en/docs/shortcodes/mermaid.md +++ b/themes/hugo-book/exampleSite/content.en/docs/shortcodes/mermaid.md @@ -10,6 +10,35 @@ create a `mermaid.json` file in your `assets` folder! ## Example +{{% columns %}} + +````tpl +```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 +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. +``` + +{{% /columns %}} {{% columns %}} @@ -28,7 +57,7 @@ stateDiagram-v2 <---> -{{<mermaid>}} +{{< mermaid >}} stateDiagram-v2 State1: The state with a note note right of State1 @@ -37,6 +66,129 @@ stateDiagram-v2 end note State1 --> State2 note left of State2 : This is the note to the left. -{{</mermaid>}} +{{< /mermaid >}} {{% /columns %}} + +## Diagrams +Explore more diagrams and syntax on Mermaid [documentation page](https://mermaid.js.org/syntax/flowchart.html). + +{{% columns %}} + +```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 +sequenceDiagram + Alice->>John: Hello John, how are you? + John-->>Alice: Great! + Alice-)John: See you later! +``` + +```mermaid +--- +title: Animal example +--- +classDiagram + note "From Duck till Zebra" + Animal <|-- Duck + note for Duck "can fly\ncan swim\ncan dive\ncan help in debugging" + 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() + } +``` + +```mermaid +--- +title: Simple sample +--- +stateDiagram-v2 + [*] --> Still + Still --> [*] + + Still --> Moving + Moving --> Still + Moving --> Crash + Crash --> [*] +``` + +<---> + +```mermaid +--- +title: Example Git diagram +--- +gitGraph + commit + commit + branch develop + checkout develop + commit + commit + checkout main + merge develop + commit + commit +``` + +```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 Another :2014-01-12, 12d + another task :24d +``` + +```mermaid +pie title Pets adopted by volunteers + "Dogs" : 386 + "Cats" : 85 + "Rats" : 15 +``` + +```mermaid +quadrantChart + title Reach and engagement of campaigns + x-axis Low Reach --> High Reach + y-axis Low Engagement --> High Engagement + quadrant-1 We should expand + quadrant-2 Need to promote + quadrant-3 Re-evaluate + quadrant-4 May be improved + Campaign A: [0.3, 0.6] + Campaign B: [0.45, 0.23] + Campaign C: [0.57, 0.69] + Campaign D: [0.78, 0.34] + Campaign E: [0.40, 0.34] + Campaign F: [0.35, 0.78] +``` + +{{% /columns %}}
\ No newline at end of file |
