jinja2_mermaid_extension 1.0.0

A jinja2 block to render a mermaid diagram

jinja2-mermaid-extension

A jinja2 block to render a mermaid diagram.

• Github repository: https://github.com/AdamGagorik/jinja2-mermaid-extension/
• Documentation https://AdamGagorik.github.io/jinja2-mermaid-extension/

Setup

• Docker must be installed to run the mermaid 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])

Usage

The following jinaj2 block will be transformed into an image and referenced in the rendered string.

{% mermaid -%}
theme: default
scale: 3
width: 75
align: center
caption: |
    An example mermaid diagram!
diagram: |
    graph TD
        A --> B
        B --> C
        A --> C
{% endmermaid %}

---

Repository initiated with fpgmaas/cookiecutter-poetry.