From e2786374ada0db53a5b171f0eaeb09f7d8216891 Mon Sep 17 00:00:00 2001 From: Collin Brooks Date: Sun, 11 Apr 2021 10:49:09 -0500 Subject: [PATCH] Add documentation for mermaid init config override (#317) * Add documentation for mermaid init config override * Capitalize Mermaid Co-authored-by: Collin Brooks --- README.md | 1 + exampleSite/content/docs/shortcodes/mermaid.md | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/README.md b/README.md index fc2f078..25df99d 100644 --- a/README.md +++ b/README.md @@ -254,6 +254,7 @@ There are few empty partials you can override in `layouts/partials/` | `assets/_custom.scss` | Customise or override scss styles | | `assets/_variables.scss` | Override default SCSS variables | | `assets/_fonts.scss` | Replace default font with custom fonts (e.g. local files or remote like google fonts) | +| `assets/mermaid.json` | Replace Mermaid initialization config | ### Plugins 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 >}} +