A jinja2 block to render a mermaid diagram
Project description
jinja2-mermaid-extension
A jinja2 block to render a mermaid diagram.
- The diagram is rendered using the
mermaid-cli
tool in aDocker
container. - The diagram is saved to the current directory or
mermaid_output_root
(if defined). - The block is then replaced with a configurable string (markdown, etc).
Setup
Docker
must be installed to run themermaid
command line tool.- The extension should be installed in your
Python
environment.
pip install jinja2-mermaid-extension
- The extension should be added to the
jinja2
environment.
from jinja2 import Environment
from jinja2_mermaid_extension import MermaidExtension
env = Environment(extensions=[MermaidExtension])
- You should pass the
mermaid_output_root
to the render method.
out_path = Path().cwd() / "example.md"
template = env.get_template("example.md.jinja2")
rendered = template.render(mermaid_output_root=out_path.parent)
out_path.write_text(rendered)
Usage
The following jinaj2
block will render a mermaid diagram.
{% mermaid -%}
ext: .png
name: test
mode: myst
scale: 3
width: 75
align: center
caption: |
An example mermaid diagram!
diagram: |
graph TD
A --> B
B --> C
A --> C
{% endmermaid %}
The output will be replaced with a MyST
formatted markdown image.
:::{figure} ./test.png
:align: center
:witdh: 75
An example mermaid diagram!
:::
The following arguments are available:
Argument | Kind | Description | Default |
---|---|---|---|
diagram or inp | Input | The raw mermaid diagram code or the path to an mmd file. |
None |
ext | Output | The file extension of the generated diagram. | ".png" |
mode | Replacement Option | How to render the output after processing. | "path" |
theme | Mermaid CLI Option | The theme to use for the diagram. | "default" |
scale | Mermaid CLI Option | A scaling factor for the diagram. | 3 |
width | Mermaid CLI Option | The width of the diagram in pixels. | 800 |
height | Mermaid CLI Option | The height of the diagram in pixels. | None |
background | Mermaid CLI Option | The background color of the generated diagram. | "white" |
alt_text | Replacement Option | The alt text of the diagram. | None |
align | Replacement Option | The alignment of the diagram only valid for MyST output) | "center" |
caption | Replacement Option | A caption to add to the diagram only valid for MyST output). | None |
just_name | Replacement Option | Whether to only output the name of the generated diagram. | False |
full_path | Replacement Option | Whether to output the full path of the generated diagram. | False |
use_cached | Processing Option | Whether to use a cached version of the diagram. | True |
parallel | Processing Option | Whether to render the diagram in parallel. | False |
temp_dir | Processing Option | A temporary directory to use for intermediate files. | None |
delete_temp_dir | Processing Option | Whether to delete the temporary directory after execution. | True |
mermaid_docker_image | Processing Option | The docker image containing the mermaid-cli tool. | "minlag/mermaid-cli" |
mermaid_volume_mount | Processing Option | The directory in the docker container to mount the temporary directory to. | "/data" |
use_local_mmdc_instead | Processing Option | Whether to use the docker image or a locally installed mermaid-cli tool named mmdc. | False |
The block will be replaced by a string based on the mode
argument.
path
: Output the path to the generated image.markdown
: Output a simple markdown image link.restructured
: Output a restructured text image link.myst_markdown
: Output a MyST formatted markdown image.
For example, when using mode: markdown
, the example above will be replaced with:
![An example mermaid diagram!](./test.png)
- Github repository: https://github.com/AdamGagorik/jinja2-mermaid-extension/
- Documentation https://AdamGagorik.github.io/jinja2-mermaid-extension/
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for jinja2_mermaid_extension-1.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 437babd6f070ebf62eecb9f6086aafbb78ea4b528cef705ac52547b2211aedf4 |
|
MD5 | 79f6e671b2101a5f6653c90729110114 |
|
BLAKE2b-256 | 36f470c4e1cc92cbd2c4b14725ddcab608e09a6a3db7d2cfc3764ab8d9934755 |
Close
Hashes for jinja2_mermaid_extension-1.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee5ed13968fd3b27144bcc1a382d9046a182c18e99de365e875497e97cadffa5 |
|
MD5 | 7c92fd78a65b01e1b19917de38e60400 |
|
BLAKE2b-256 | bb6d1f935cff2d9d76a37f326c7bb1a4ce08607bbd8cdccb6834ac810a3d27a5 |