docs: add mermaid shortcode usage

This commit is contained in:
ZzMzaw 2024-10-07 05:44:07 +02:00
parent 7b00ed1d9d
commit 54acef5e2c

View file

@ -91,6 +91,18 @@ The Mermaid shortcode supports two parameters:
{{ admonition(type="tip", text="You can use the [Mermaid Live Editor](https://mermaid.live/) to create and preview your diagrams.") }}
#### Usage
```
{%/* mermaid(invertible=true, full_width=false) */%}
Your diagram goes here.
`invertible` or `full_width` can be omitted if default values are used.
{%/* end */%}
```
## Image shortcodes
All image shortcodes support absolute paths, relative paths, and remote sources in the `src` parameter.