Overview

Django Mermaid is a Python package that allows users to use mermaid diagrams in Django templates. Mermaid is a JavaScript-based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically.

Features

Installation: Easy installation process with code snippets provided.
Configuration: Guide to configuring Django Mermaid in your Django project's settings.py file.
Usage: Instructions on how to load and use mermaid in your templates using template tags.
Mermaid version: Ability to specify a specific version of mermaid to use.
Mermaid theme: Set a default theme for your project or dynamically override it in the template tag.
Mermaid theme variables: Customize the theme by overriding the available theme variables.
Contribute: Users are encouraged to contribute by opening issues or pull requests.
License: Django Mermaid is licensed under the MIT license.

Summary

Django Mermaid is a Python package that integrates the mermaid diagramming and charting tool with Django templates. With easy installation and configuration, users can quickly start using mermaid diagrams in their Django projects. The package also provides flexibility in choosing the mermaid version and customizing the theme. Contributions are encouraged, and the package is licensed under the MIT license.

Pysnippet

Django Mermaid