hugo-geekdoc/exampleSite/content/en/shortcodes/mermaid.md

1.5 KiB

title
Mermaid

Mermaid is library for generating SVG charts and diagrams from text.

Usage

{{</* 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

{{< propertylist name=shortcode-mermaid sort=name order=asc >}}

Example

{{< 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 >}}

As an alternative to shortcodes, code blocks can be used for markdown as well.

{{< columns >}}

```mermaid
flowchart LR
A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]
```

<--->

flowchart LR
A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]

{{< /columns >}}