https://github.com/pysnippet/django-mermaid
Django template tag for rendering mermaid diagrams.
https://github.com/pysnippet/django-mermaid
diagram django graph jinja mermaid python tag template
Last synced: 2 months ago
JSON representation
Django template tag for rendering mermaid diagrams.
- Host: GitHub
- URL: https://github.com/pysnippet/django-mermaid
- Owner: pysnippet
- License: mit
- Created: 2023-03-11T18:11:21.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-06-02T16:54:06.000Z (almost 2 years ago)
- Last Synced: 2025-02-06T11:17:40.030Z (2 months ago)
- Topics: diagram, django, graph, jinja, mermaid, python, tag, template
- Language: Python
- Homepage:
- Size: 637 KB
- Stars: 12
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- stars - pysnippet/django-mermaid - Django template tag for rendering mermaid diagrams. (Python)
- stars - pysnippet/django-mermaid - Django template tag for rendering mermaid diagrams. (Python)
README
# Django Mermaid
[](https://pypi.org/project/django-mermaid/)
[](https://pypi.org/project/django-mermaid/)
[](https://pypi.org/project/django-mermaid/)
[](https://github.com/pysnippet/django-mermaid/blob/master/LICENSE)
[](https://github.com/pysnippet/django-mermaid/actions/workflows/tests.yml)Mermaid is a JavaScript-based diagramming and charting tool that renders Markdown-inspired text definitions to create
and modify diagrams dynamically. And Django Mermaid aims to use mermaid diagrams in Django templates.## Installation
```shell
python -m pip install django-mermaid
```## Configuration
Add the `django_mermaid.apps.MermaidConfig` to your `INSTALLED_APPS` in your Django project's **settings.py** file.
```python
INSTALLED_APPS = [
..., # other apps
'django_mermaid.apps.MermaidConfig',
]
```## Usage
After you configure the `INSTALLED_APPS`, you will be able to load the `mermaid` in your template and use the template
tag for rendering mermaid diagrams.```jinja2
{% load mermaid %}
{% mermaid "graph LR; A-->B;" %}
```### Mermaid version
By default, Django Mermaid uses the **9.4.3** version of mermaid. However, if you want to use a specific version of
mermaid, you can set the `MERMAID_VERSION` variable in your Django project's **settings.py** file.```python
MERMAID_VERSION = '10.0.3-alpha.1'
```Make sure the version you specify is available on the [mermaid CDN](https://cdnjs.com/libraries/mermaid), and has
the **mermaid.min.js** file.### Mermaid theme
To set a default theme for the whole project, set the `MERMAID_THEME` variable in your Django project's **settings.py**
file. However, Django Mermaid uses
the [default](https://github.com/mermaid-js/mermaid/blob/develop/packages/mermaid/src/themes/theme-default.js) theme of
mermaid by default. Also, check out the mermaid [docs](https://mermaid.js.org/config/theming.html?#theme-variables) for
the available themes.```python
MERMAID_THEME = 'neutral'
```Also, you can provide the theme right in the template tag which will dynamically override the value of
the `MERMAID_THEME` variable.```jinja2
{% mermaid "graph LR; A-->B;" "dark" %}
```### Mermaid theme variables
You can define your custom theme by overriding the `MERMAID_THEME_VARIABLES` variable. You will need to use
the [base](https://github.com/mermaid-js/mermaid/blob/develop/packages/mermaid/src/themes/theme-base.js) theme as it is
the only modifiable theme. Check out the mermaid [docs](https://mermaid.js.org/config/theming.html?#theme-variables) for
the complete and up-to-date list of available theme variables.```python
MERMAID_THEME_VARIABLES = {
'primaryColor': '#BB2528',
'primaryTextColor': '#FFF',
}
```## Contribute
Any contribution is welcome. If you have any ideas or suggestions, feel free to open an issue or a pull request. And
don't forget to add tests for your changes.## License
Copyright (C) 2023 Artyom Vancyan. [MIT](https://github.com/pysnippet/django-mermaid/blob/master/LICENSE)
