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>
This commit is contained in:
parent
1e4bcc2cc3
commit
e2786374ad
2 changed files with 9 additions and 0 deletions
|
@ -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
|
||||
|
||||
|
|
|
@ -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 >}}
|
||||
|
||||
|
|
Loading…
Reference in a new issue