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
Key | Description |
---|---|
ServerURL |
URL of your kroki-Server, default: !ENV [KROKI_SERVER_URL, 'https://kroki.io'] |
FencePrefix |
Diagram prefix, default: kroki- |
EnableBlockDiag |
Enable BlockDiag (and the related Diagrams), default: true |
Enablebpmn |
Enable BPMN, default: true |
EnableExcalidraw |
Enable Excalidraw, default: true |
EnableMermaid |
Enable Mermaid, default: true |
EnableDiagramsnet |
Enable diagrams.net (draw.io), default: false |
HttpMethod |
Http method to use (GET or POST ), default: GET Note: On POST the retrieved images are stored next to the including page in the build directory |
UserAgent |
User agent for requests to the kroki server, default: kroki.plugin/0.7.1 |
FileTypes |
File types you want to use, default: [svg] Note: not all file formats work with all diagram types https://kroki.io/#support |
FileTypeOverrides |
Overrides for specific diagram types to set the desired file type, default: empty |
FailFast |
Errors are raised as plugin errors, default: false |
Example:
- kroki:
ServerURL: !ENV [KROKI_SERVER_URL, 'https://kroki.io']
FileTypes:
- png
- svg
FileTypeOverrides:
mermaid: png
FailFast: !ENV CI
Usage
Use code-fences with a tag of kroki-<Module>
to replace the code with the wanted diagram.
Diagram options can be set as well.
Example for BlockDiag:
```kroki-blockdiag no-transparency=false
blockdiag {
blockdiag -> generates -> "block-diagrams";
blockdiag -> is -> "very easy!";
blockdiag [color = "greenyellow"];
"block-diagrams" [color = "pink"];
"very easy!" [color = "orange"];
}
```
You can render diagram from file with @from_file:
directive:
```kroki-bpmn
@from_file:path/to/diagram.bpmn
```
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
Development
Setup:
git clone git@github.com:AVATEAM-IT-SYSTEMHAUS/mkdocs-kroki-plugin.git
cd mkdocs-kroki-plugin
pipx install hatch
pipx install pre-commit
pre-commit install
Run tests (for all supported python versions):
hatch test -a
Run static code analysis:
hatch fmt
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
Hashes for mkdocs_kroki_plugin-0.8.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f63de62dafec07e10231f13e3b7038565f341a5e117f4e5084e782d5168dbeb |
|
MD5 | 864d6937c9293bda8db7429da0b48a3b |
|
BLAKE2b-256 | 844bcb785363eec4667ec8b3828f6c350207abdd5a65127efe849e2e3da313cd |
Hashes for mkdocs_kroki_plugin-0.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7450fcc02151d4e5ba8433599e75e1cd45bff11666c539ed63d69d544012e899 |
|
MD5 | d17468893735cb1d1db86ecd125787dc |
|
BLAKE2b-256 | b1a7c507dbbfa540a49c2e13249c84898bb814d967e36aa86bbc31d1aba7e5e1 |