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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c545be9ec27e524fb0fa99fbc29bc8278c634384c020229fa07ca6302432a84a |
|
MD5 | 1c2ccd43ef98e096267fda2c200a411e |
|
BLAKE2b-256 | 01f07577510b2a68aae040207c3e9c138963e45716c6794808291ccbce3a14c9 |
Close
Hashes for mkdocs_kroki_plugin-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f2861a492aa37b561d263aa00d4b77584ad21e7837ef717259c94a78555ef50 |
|
MD5 | 7cb65191d76777b612119efaaec8b5ab |
|
BLAKE2b-256 | edda01f0e995f180f923ad7d502db03b728774eee5f8942d5c55398364f28ca1 |