hugo-book-theme/exampleSite/content.en/docs/shortcodes/mermaid.md

1.1 KiB

Mermaid Chart

MermaidJS is library for generating svg charts and diagrams from text.

{{< hint info >}} Override Mermaid Initialization Config

To override the initialization config for Mermaid, create a mermaid.json file in your assets folder! {{< /hint >}}

Example

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

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