mirror of
https://github.com/welpo/tabi.git
synced 2025-10-11 07:46:15 +02:00
📝 docs: add mermaid shortcode usage (#407)
Co-authored-by: welpo <welpo@users.noreply.github.com>
This commit is contained in:
parent
7b00ed1d9d
commit
3fddb1f9a1
3 changed files with 34 additions and 0 deletions
|
@ -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.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue