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
Pre-Release-Versions
Install the newest pre-release version using pip:
pip install -i https://test.pypi.org/simple/ mkdocs-kroki-plugin
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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef9036a004fa703ff9b87cba59977c98d039dd4237616c677e61549b813c56c7 |
|
MD5 | 45dbcb1ed0571dda6b5f4b345b977745 |
|
BLAKE2b-256 | 83e532b6e32c53c8f8b9b92b56f02e98a96eaae5788f3d5f3f0973a152d9c835 |
Close
Hashes for mkdocs_kroki_plugin-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 958d61bd2819af6109b9274b740f6af2b3959a5346aa705c702aa6959fa3693d |
|
MD5 | fa2c2be53f398a6d4ef633fda49b9570 |
|
BLAKE2b-256 | b60657f06bdea0a824fa2253868ebb62ac965be4e26be652d986006ef35b6488 |