MkDocs plugin for Kroki-Diagrams
Project description
mkdocs-kroki-plugin
This is a MkDocs plugin to embed Kroki-Diagrams into your documentation.
Setup
Install the plugin using pip:
pip install mkdocs-kroki-plugin
Activate the plugin in mkdocs.yml
:
plugins:
...
- kroki:
Config
ServerURL
- URL of your kroki-Server, default: https://kroki.ioEnableBlockDiag
- Enable BlockDiag (and the related Diagrams), default: TrueEnablebpmn
- Enable BPMN, default: TrueEnableExcalidraw
- Enable Excalidraw, default: TrueEnableMermaid
- Enable Mermaid, default: True
Usage
Use code-fences with a tag of kroki-<Module>
to replace the code with the wanted diagram.
Example for BlockDiag:
```kroki-blockdiag
blockdiag {
blockdiag -> generates -> "block-diagrams";
blockdiag -> is -> "very easy!";
blockdiag [color = "greenyellow"];
"block-diagrams" [color = "pink"];
"very easy!" [color = "orange"];
}
```
See Also
Diagram examples can be found here.
More information about installing a self-manged Kroki-Service here.
More Plugins for MkDocs can be found 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.
Source Distribution
Built Distribution
Close
Hashes for mkdocs-kroki-plugin-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 98c1ceb6c55adeb1548b418f532cb84691a2fe6bc70b8e03b39187d2355a1915 |
|
MD5 | 274ab7e150a89c6c1ac71d0a295af29c |
|
BLAKE2b-256 | dcedf468b6b053c2159bb2a5bf1c2a728fec799e241727fca40b2ba0a286da41 |
Close
Hashes for mkdocs_kroki_plugin-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c44b4d4ffc314339035ae2548c133249caaf09bd710c4e9b770a6587ccba3b2 |
|
MD5 | 4f31d39b5b754e7aa0e071502269aa87 |
|
BLAKE2b-256 | 6a93b8b07b9426ae9b1d9d92ad4be4ba3eb7591afd41801f0810e995c5fbe155 |