📝 docs: add mermaid shortcode usage (#407)

Co-authored-by: welpo <welpo@users.noreply.github.com>
This commit is contained in:
ZzMzaw 2024-10-08 01:25:36 +02:00 committed by GitHub
parent 7b00ed1d9d
commit 3fddb1f9a1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 34 additions and 0 deletions

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.