e2786374ad
* Add documentation for mermaid init config override * Capitalize Mermaid Co-authored-by: Collin Brooks <cbrooks@sentryds.com>
46 lines
1,014 B
Markdown
46 lines
1,014 B
Markdown
# Mermaid Chart
|
|
|
|
[Mermaid](https://mermaidjs.github.io/) is library for generating svg charts and diagrams from text.
|
|
|
|
{{< hint info >}}
|
|
**Override Mermaid Initialization Config**
|
|
|
|
To override the [initialization config](https://mermaid-js.github.io/mermaid/#/Setup) for Mermaid,
|
|
create a `mermaid.json` file in your `assets` folder!
|
|
{{< /hint >}}
|
|
|
|
## Example
|
|
|
|
{{< columns >}}
|
|
```tpl
|
|
{{</* 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 >}}
|
|
|