Python-Markdown extension to add support for mermaid graph inside markdown file.
Project description
md_mermaid
mermaid extension for Python-Markdown to add support for mermaid graph inside markdown file
Installation
For pip
installation (only python version >=3.x) :
pip install markdown pip install md-mermaid
Usage
In your python script :
import markdown text = """ # Title Some text. ~~~mermaid graph TB A --> B B --> C ~~~ Some other text. ~~~mermaid graph TB D --> E E --> F ~~~ """ html = markdown.markdown(text, extensions=['md_mermaid']) print(html)
Output will result in :
<h1>Title</h1> <p>Some text.</p> <div class="mermaid"> graph TB A --> B B --> C </div> <p>Some other text.</p> <div class="mermaid"> graph TB D --> E E --> F </div> <script>mermaid.initialize({startOnLoad:true});</script>
The <script>...</script>
line appears only once even if there are several graphs in the file.
Note that the extension name have a '_' not a '-'.
Attention : don't forget to include in your output html project the two following mermaid files :
- mermaid.css (optional, can be customised)
- mermaid.min.js (can be download here here)
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.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size md_mermaid-0.1.1-py3-none-any.whl (15.3 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
Filename, size md_mermaid-0.1.1.tar.gz (2.8 kB) | File type Source | Python version None | Upload date | Hashes View |
Close
Hashes for md_mermaid-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23da1dd476dd399c83247aead84af5e67b672e0fd3cb96899303ea6a8ed7717d |
|
MD5 | 5ab38471c3741fd73b177a13c261f10c |
|
BLAKE2-256 | ed852136d104d685ecfbec88ddae282fb92f4a7e9e35f47eec7ec0b3a9f4060d |