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.ioFencePrefix
- Diagram prefix, default:kroki-
EnableBlockDiag
- Enable BlockDiag (and the related Diagrams), default: TrueEnablebpmn
- Enable BPMN, default: TrueEnableExcalidraw
- Enable Excalidraw, default: TrueEnableMermaid
- Enable Mermaid, default: TrueDownloadImages
- Download diagrams from kroki as static assets instead of just creating kroki links, default: FalseDownloadDir
- The asset directory to place downloaded svg images in, default: images/kroki_generated
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.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 075980011d1c9a54819948f41a3a9ce5a3edc9d85e1bca331503391d043c7f1c |
|
MD5 | 56b893e4f185403bf1b40cb0befbea1c |
|
BLAKE2b-256 | f537efeaf0e308815a07cac7ac7c5c6a6628cf37f26aa525885ebc9cb015149b |
Close
Hashes for mkdocs_kroki_plugin-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5faf4d5711d5e9268f447083e14a59733376ab0b989e88b749915ad4caa2cd4a |
|
MD5 | 9cfce22deb266d92c612e57cb22179ee |
|
BLAKE2b-256 | 9d98291b9417bfc0de74602175f058b5e23fb3b90779d7756dabc26a01d2a4f0 |