aboutsummaryrefslogtreecommitdiff
path: root/exampleSite
diff options
context:
space:
mode:
authorCollin Brooks <collin.brooks@gmail.com>2021-04-11 10:49:09 -0500
committerGitHub <noreply@github.com>2021-04-11 17:49:09 +0200
commite2786374ada0db53a5b171f0eaeb09f7d8216891 (patch)
tree42869985e0ab9d7cfa54547761c00705f5235bc1 /exampleSite
parent1e4bcc2cc3186794c1becbe0a0d9c924264d0146 (diff)
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>
Diffstat (limited to 'exampleSite')
-rw-r--r--exampleSite/content/docs/shortcodes/mermaid.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/exampleSite/content/docs/shortcodes/mermaid.md b/exampleSite/content/docs/shortcodes/mermaid.md
index 3a617bc..c37e6b2 100644
--- a/exampleSite/content/docs/shortcodes/mermaid.md
+++ b/exampleSite/content/docs/shortcodes/mermaid.md
@@ -2,6 +2,13 @@
[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 >}}
@@ -36,3 +43,4 @@ sequenceDiagram
{{< /mermaid >}}
{{< /columns >}}
+