style: fix autoformat in mermaid examples

This commit is contained in:
Marcel Beck 2023-07-28 21:16:37 +02:00
parent be45120c46
commit 66ef1762f1

View file

@ -43,18 +43,18 @@ graph LR;
{{% /tab %}} {{% /tab %}}
{{% tab title="shortcode" %}} {{% tab title="shortcode" %}}
```go ````go
{{</* mermaid align="center" zoom="true" */>}} {{</* mermaid align="center" zoom="true" */>}}
graph LR; graph LR;
If --> Then If --> Then
Then --> Else Then --> Else
{{</* /mermaid */>}} {{</* /mermaid */>}}
``` ````
{{% /tab %}} {{% /tab %}}
{{% tab title="partial" %}} {{% tab title="partial" %}}
```go ````go
{{ partial "shortcodes/mermaid.html" (dict {{ partial "shortcodes/mermaid.html" (dict
"page" . "page" .
"content" "graph LR;\nIf --> Then\nThen --> Else" "content" "graph LR;\nIf --> Then\nThen --> Else"
@ -62,7 +62,7 @@ graph LR;
"zoom" "true" "zoom" "true"
)}} )}}
``` ````
{{% /tab %}} {{% /tab %}}
{{< /tabs >}} {{< /tabs >}}
@ -72,7 +72,7 @@ The generated graphs can be be panned by dragging them and zoomed by using the m
### Parameter ### Parameter
| Name | Default | Notes | | Name | Default | Notes |
| --------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |-----------------------|------------------|-------------|
| **align** | `center` | Allowed values are `left`, `center` or `right`. | | **align** | `center` | Allowed values are `left`, `center` or `right`. |
| **zoom** | see notes | Whether the graph is pan- and zoomable.<br><br>If not set the value is determined by the `mermaidZoom` setting of the [site](#global-configuration-file) or the [pages frontmatter](#pages-frontmatter) or `false` if not set at all.<br><br>- `false`: no pan or zoom<br>- `true`: pan and zoom active | | **zoom** | see notes | Whether the graph is pan- and zoomable.<br><br>If not set the value is determined by the `mermaidZoom` setting of the [site](#global-configuration-file) or the [pages frontmatter](#pages-frontmatter) or `false` if not set at all.<br><br>- `false`: no pan or zoom<br>- `true`: pan and zoom active |
| _**&lt;content&gt;**_ | _&lt;empty&gt;_ | Your Mermaid graph. | | _**&lt;content&gt;**_ | _&lt;empty&gt;_ | Your Mermaid graph. |
@ -93,7 +93,7 @@ To use codefence syntax you have to turn off `guessSyntax` for the `markup.highl
### Global Configuration File ### Global Configuration File
```toml ````toml
[params] [params]
mermaidInitialize = "{ \"theme\": \"dark\" }" mermaidInitialize = "{ \"theme\": \"dark\" }"
mermaidZoom = true mermaidZoom = true
@ -104,22 +104,22 @@ To use codefence syntax you have to turn off `guessSyntax` for the `markup.highl
# was given BUT Mermaid and Math codefences will not work anymore! So this is a # was given BUT Mermaid and Math codefences will not work anymore! So this is a
# mandatory setting for your site if you want to use Mermaid codefences # mandatory setting for your site if you want to use Mermaid codefences
guessSyntax = false guessSyntax = false
``` ````
### Page's Frontmatter ### Page's Frontmatter
```toml ````toml
+++ +++
mermaidInitialize = "{ \"theme\": \"dark\" }" mermaidInitialize = "{ \"theme\": \"dark\" }"
mermaidZoom = true mermaidZoom = true
+++ +++
``` ````
## Examples ## Examples
### Flowchart with YAML-Title ### Flowchart with YAML-Title
```go ````go
{{</* mermaid */>}} {{</* mermaid */>}}
--- ---
title: Example Diagram title: Example Diagram
@ -130,12 +130,12 @@ graph LR;
C -->|One| D[Result one] C -->|One| D[Result one]
C -->|Two| E[Result two] C -->|Two| E[Result two]
{{</* /mermaid */>}} {{</* /mermaid */>}}
``` ````
## {{< mermaid >}}
## title: Example Diagram
{{< mermaid >}}
---
title: Example Diagram
---
graph LR; graph LR;
A[Hard edge] -->|Link text| B(Round edge) A[Hard edge] -->|Link text| B(Round edge)
B --> C{<strong>Decision</strong>} B --> C{<strong>Decision</strong>}
@ -145,7 +145,7 @@ C -->|Two| E[Result two]
### Sequence Diagram with Configuration Directive ### Sequence Diagram with Configuration Directive
```go ````go
{{</* mermaid */>}} {{</* mermaid */>}}
%%{init:{"fontFamily":"monospace", "sequence":{"showSequenceNumbers":true}}}%% %%{init:{"fontFamily":"monospace", "sequence":{"showSequenceNumbers":true}}}%%
sequenceDiagram sequenceDiagram
@ -158,7 +158,7 @@ sequenceDiagram
John->>Bob: How about you? John->>Bob: How about you?
Bob-->>John: Jolly good! Bob-->>John: Jolly good!
{{</* /mermaid */>}} {{</* /mermaid */>}}
``` ````
{{< mermaid >}} {{< mermaid >}}
%%{init:{"fontFamily":"monospace", "sequence":{"showSequenceNumbers":true}}}%% %%{init:{"fontFamily":"monospace", "sequence":{"showSequenceNumbers":true}}}%%
@ -201,7 +201,7 @@ classDiagram
``` ```
```` ````
```mermaid ````mermaid
classDiagram classDiagram
Animal <|-- Duck Animal <|-- Duck
Animal <|-- Fish Animal <|-- Fish
@ -223,11 +223,11 @@ classDiagram
+bool is_wild +bool is_wild
+run() +run()
} }
``` ````
### State Diagram Aligned to the Right ### State Diagram Aligned to the Right
```go ````go
{{</* mermaid align="right" */>}} {{</* mermaid align="right" */>}}
stateDiagram-v2 stateDiagram-v2
open: Open Door open: Open Door
@ -238,7 +238,7 @@ stateDiagram-v2
locked --> closed: Unlock locked --> closed: Unlock
closed --> open: Open closed --> open: Open
{{</* /mermaid */>}} {{</* /mermaid */>}}
``` ````
{{< mermaid align="right" >}} {{< mermaid align="right" >}}
stateDiagram-v2 stateDiagram-v2
@ -253,7 +253,7 @@ closed --> open: Open
### Entity Relationship Model with Non-Default Mermaid Theme ### Entity Relationship Model with Non-Default Mermaid Theme
```go ````go
{{</* mermaid */>}} {{</* mermaid */>}}
%%{init:{"theme":"forest"}}%% %%{init:{"theme":"forest"}}%%
erDiagram erDiagram
@ -266,7 +266,7 @@ erDiagram
PRODUCT-CATEGORY ||--|{ PRODUCT : contains PRODUCT-CATEGORY ||--|{ PRODUCT : contains
PRODUCT ||--o{ ORDER-ITEM : "ordered in" PRODUCT ||--o{ ORDER-ITEM : "ordered in"
{{</* /mermaid */>}} {{</* /mermaid */>}}
``` ````
{{< mermaid >}} {{< mermaid >}}
%%{init:{"theme":"forest"}}%% %%{init:{"theme":"forest"}}%%
@ -283,7 +283,7 @@ PRODUCT ||--o{ ORDER-ITEM : "ordered in"
### User Journey ### User Journey
```go ````go
{{</* mermaid */>}} {{</* mermaid */>}}
journey journey
title My working day title My working day
@ -295,7 +295,7 @@ journey
Go downstairs: 5: Me Go downstairs: 5: Me
Sit down: 3: Me Sit down: 3: Me
{{</* /mermaid */>}} {{</* /mermaid */>}}
``` ````
{{< mermaid >}} {{< mermaid >}}
journey journey
@ -311,7 +311,7 @@ Sit down: 3: Me
### GANTT Chart ### GANTT Chart
```go ````go
{{</* mermaid */>}} {{</* mermaid */>}}
gantt gantt
dateFormat YYYY-MM-DD dateFormat YYYY-MM-DD
@ -329,7 +329,7 @@ gantt
Create tests for renderer :2d Create tests for renderer :2d
Add to Mermaid :1d Add to Mermaid :1d
{{</* /mermaid */>}} {{</* /mermaid */>}}
``` ````
{{< mermaid >}} {{< mermaid >}}
gantt gantt
@ -351,14 +351,14 @@ Add to Mermaid :1d
### Pie Chart without Zoom ### Pie Chart without Zoom
```go ````go
{{</* mermaid zoom="false" */>}} {{</* mermaid zoom="false" */>}}
pie title Pets adopted by volunteers pie title Pets adopted by volunteers
"Dogs" : 386 "Dogs" : 386
"Cats" : 85 "Cats" : 85
"Rats" : 15 "Rats" : 15
{{</* /mermaid */>}} {{</* /mermaid */>}}
``` ````
{{< mermaid zoom="false" >}} {{< mermaid zoom="false" >}}
pie title Pets adopted by volunteers pie title Pets adopted by volunteers
@ -369,7 +369,7 @@ pie title Pets adopted by volunteers
### Requirement Diagram ### Requirement Diagram
```go ````go
{{</* mermaid */>}} {{</* mermaid */>}}
requirementDiagram requirementDiagram
@ -386,7 +386,7 @@ pie title Pets adopted by volunteers
test_entity - satisfies -> test_req test_entity - satisfies -> test_req
{{</* /mermaid */>}} {{</* /mermaid */>}}
``` ````
{{< mermaid >}} {{< mermaid >}}
requirementDiagram requirementDiagram
@ -403,12 +403,11 @@ requirementDiagram
} }
test_entity - satisfies -> test_req test_entity - satisfies -> test_req
{{< /mermaid >}} {{< /mermaid >}}
### Git Graph ### Git Graph
```go ````go
{{</* mermaid */>}} {{</* mermaid */>}}
gitGraph gitGraph
commit commit
@ -422,7 +421,7 @@ gitGraph
commit commit
commit commit
{{</* /mermaid */>}} {{</* /mermaid */>}}
``` ````
{{< mermaid >}} {{< mermaid >}}
gitGraph gitGraph
@ -440,7 +439,7 @@ commit
### C4 Diagrams ### C4 Diagrams
```go ````go
{{</* mermaid */>}} {{</* mermaid */>}}
C4Context C4Context
title System Context diagram for Internet Banking System title System Context diagram for Internet Banking System
@ -485,7 +484,7 @@ C4Context
UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1") UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1")
{{</* /mermaid */>}} {{</* /mermaid */>}}
``` ````
{{< mermaid >}} {{< mermaid >}}
C4Context C4Context
@ -530,12 +529,11 @@ Person_Ext(customerC, "Banking Customer C", "desc")
UpdateRelStyle(SystemC, customerA, $textColor="red", $lineColor="red", $offsetX="-50", $offsetY="20") UpdateRelStyle(SystemC, customerA, $textColor="red", $lineColor="red", $offsetX="-50", $offsetY="20")
UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1") UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1")
{{< /mermaid >}} {{< /mermaid >}}
### Mindmaps ### Mindmaps
```go ````go
{{</* mermaid */>}} {{</* mermaid */>}}
mindmap mindmap
root((mindmap)) root((mindmap))
@ -555,7 +553,7 @@ mindmap
Pen and paper Pen and paper
Mermaid Mermaid
{{</* /mermaid */>}} {{</* /mermaid */>}}
``` ````
{{< mermaid >}} {{< mermaid >}}
mindmap mindmap
@ -579,7 +577,7 @@ Mermaid
### Timeline ### Timeline
```go ````go
{{</* mermaid */>}} {{</* mermaid */>}}
timeline timeline
title History of Social Media Platform title History of Social Media Platform
@ -589,7 +587,7 @@ timeline
2005 : Youtube 2005 : Youtube
2006 : Twitter 2006 : Twitter
{{</* /mermaid */>}} {{</* /mermaid */>}}
``` ````
{{< mermaid >}} {{< mermaid >}}
timeline timeline
@ -603,7 +601,7 @@ title History of Social Media Platform
### Sankey ### Sankey
```go ````go
{{</* mermaid */>}} {{</* mermaid */>}}
sankey-beta sankey-beta
@ -612,7 +610,7 @@ Electricity grid,Over generation / exports,104.453
Electricity grid,Heating and cooling - homes,113.726 Electricity grid,Heating and cooling - homes,113.726
Electricity grid,H2 conversion,27.14 Electricity grid,H2 conversion,27.14
{{</* /mermaid */>}} {{</* /mermaid */>}}
``` ````
{{< mermaid >}} {{< mermaid >}}
sankey-beta sankey-beta