Skip to content

Commit

Permalink
enables mermaid in docs (mmistakes#935)
Browse files Browse the repository at this point in the history
Short and sweet PR that addresses the follow-up in mmistakes#909: enabling `mermaid` on our docs site, but making it clear that users still need to opt-in to use it. I've also added an example in-action.

To test: [see the Netlify deploy](https://deploy-preview-935--just-the-docs.netlify.app/docs/ui-components/code/#mermaid-diagram-code-blocks).
  • Loading branch information
mattxwang authored Aug 21, 2022
1 parent 4d790e8 commit 011f783
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 9 deletions.
17 changes: 9 additions & 8 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,15 @@ search:
# Supports true or false (default)
button: false

# To enable support for mermaid diagrams (https://mermaid-js.github.io/mermaid/),
# uncomment the `mermaid` and `version` keys below
# mermaid:
# # Version of mermaid library
# # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
# version: "9.1.3"
# # Put any additional configuration, such as setting the theme, in _includes/mermaid_config.js
# # See also docs/ui-components/code
# To disable support for mermaid diagrams (https://mermaid-js.github.io/mermaid/),
# comment out the `mermaid` and `version` keys below
# By default, consuming the theme as a gem leaves mermaid disabled; it is opt-in
mermaid:
# Version of mermaid library
# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
version: "9.1.6"
# Put any additional configuration, such as setting the theme, in _includes/mermaid_config.js
# See also docs/ui-components/code

# Enable or disable heading anchors
heading_anchors: true
Expand Down
14 changes: 13 additions & 1 deletion docs/ui-components/code.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ To demonstrate front end code, sometimes it's useful to show a rendered example

## Mermaid diagram code blocks

[Mermaid](https://mermaid-js.github.io/mermaid/) allows you to add diagrams and visualizations using Markdown code blocks. You can turn on support for mermaid by adding a `mermaid` key to your `_config.yml`.
[Mermaid](https://mermaid-js.github.io/mermaid/) allows you to add diagrams and visualizations using Markdown code blocks. **It is disabled by default**. However, you can turn on support for mermaid by adding a `mermaid` key to your `_config.yml`.

The minimum configuration requires a `version` key (matching a version in [jsDelivr](https://cdn.jsdelivr.net/npm/mermaid/)):

Expand Down Expand Up @@ -131,3 +131,15 @@ graph TD;
C-->D;
```
{% endhighlight %}

which renders:

```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```

*Note: for demonstration purposes, we've enabled mermaid on this site. It is still disabled by default, and users need to opt-in to use it.*

0 comments on commit 011f783

Please sign in to comment.