hugo-book-theme/exampleSite/content/docs/shortcodes/mermaid.md
Collin Brooks e2786374ad
Add documentation for mermaid init config override (#317)
* Add documentation for mermaid init config override
* Capitalize Mermaid

Co-authored-by: Collin Brooks <cbrooks@sentryds.com>
2021-04-11 17:49:09 +02:00

1,014 B

Mermaid Chart

Mermaid 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

{{< columns >}}

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

<--->

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

{{< /columns >}}