adoralaura/hugo-book-theme
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add documentation for mermaid init config override (#317)

Browse source 
* Add documentation for mermaid init config override
* Capitalize Mermaid

Co-authored-by: Collin Brooks <cbrooks@sentryds.com>
This commit is contained in:
Collin Brooks 2021-04-11 10:49:09 -05:00 committed by GitHub
parent 1e4bcc2cc3
commit e2786374ad
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
README.md
View file

@ -254,6 +254,7 @@ There are few empty partials you can override in `layouts/partials/`
| `assets/_custom.scss` | Customise or override scss styles | | `assets/_custom.scss` | Customise or override scss styles |
| `assets/_variables.scss` | Override default SCSS variables | | `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/_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 ### Plugins

8
exampleSite/content/docs/shortcodes/mermaid.md
View file

@ -2,6 +2,13 @@
[Mermaid](https://mermaidjs.github.io/) is library for generating svg charts and diagrams from text. [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 ## Example
{{< columns >}} {{< columns >}}
@ -36,3 +43,4 @@ sequenceDiagram
{{< /mermaid >}} {{< /mermaid >}}
{{< /columns >}} {{< /columns >}}