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
mode: myst
scale: 3
width: 75
align: center
caption: |
An example mermaid diagram!
diagram: |
graph TD
A --> B
B --> C
A --> C
{% endmermaid %}
The following arguments are available:
Argument | Description | Default |
---|---|---|
diagram | The diagram to render. | None |
ext | The file extension of the generated diagram. | ".png" |
mode | How to render the output after processing. | "path" |
theme | The theme to use for the diagram. | "default" |
scale | A scaling factor for the diagram. | 3 |
width | The width of the diagram in pixels. | 800 |
height | The height of the diagram in pixels. | None |
background | The background color of the generated diagram. | "white" |
alt_text | The alt text of the diagram. | None |
align | The alignment of the diagram (only valid for MyST output) | "center" |
caption | A caption to add to the diagram (only valid for MyST output). | None |
use_cached | Whether to use a cached version of the diagram. | True |
temp_dir | A temporary directory to use for intermediate files. | None |
delete_temp_dir | Whether to delete the temporary directory after execution. | True |
mermaid_docker_image | The docker image containing the mermaid-cli tool. | "minlag/mermaid-cli" |
mermaid_volume_mount | The directory in the docker container to mount the temporary directory to. | "/data" |
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.
- 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.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdb0569c1d22f65886dad644983d00854944cfcfbf0d11a189fc439a827fa0b8 |
|
MD5 | 0659f74979d48ae16ebc273d1e353a51 |
|
BLAKE2b-256 | db98ac61d18c457ca055842d95c58bf2dda53d7d3f0ee829adcb8915b0994743 |
Close
Hashes for jinja2_mermaid_extension-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69bd91879f9d5c6e52189fcd43ed678b3a870dc7b4659eff851f1c16f8a2af6d |
|
MD5 | 8bd89d682bf704bd5e0bdf13302e4586 |
|
BLAKE2b-256 | 1855981b67aac39339e30cde385cb41e2b1b02ccd404a396b5d1f8849e03913a |