Skip to content

Document escaping conflicting Mermaid syntax #2911

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nightcityblade wants to merge 1 commit into
base: master
Choose a base branch
from
+18 −0
Open

Document escaping conflicting Mermaid syntax #2911

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/userGuide/plugins/mermaid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,24 @@ By default, the plugin loads the Mermaid code from a CDN URL. However, you can o

To create a Mermaid diagram, use the `<mermaid>` tag and provide the diagram definition within the tag. Usage of standard Mermaid syntax using the `<pre class="mermaid">` block directly in Markdown files is also supported for users who prefer to do so.

<box type="tip">

Some Mermaid syntax, such as initialization directives, can conflict with MarkBind's Nunjucks processing. Wrap the conflicting line in a Nunjucks string expression so that MarkBind emits it unchanged:

{% raw %}
```html
<mermaid>
{{ "%%{init: { 'logLevel': 'debug', 'theme': 'base' } }%%" }}
gitGraph
commit id: "feat(api): ..."
</mermaid>
```
{% endraw %}

See [Using raw-endraw to display content](../tipsAndTricks.html#using-raw-endraw-to-display-content) for more ways to escape Nunjucks syntax.

</box>

{{ icon_example }} Pie Chart:

<include src="codeAndOutput.md" boilerplate >
Expand Down