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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0a56e2429ab0b80bd3874c72ac1953768f99e2976a38619ae9b0d61d5dab394 |
|
MD5 | 26801145ffbcf81382b11176e98c9a3f |
|
BLAKE2b-256 | 4d4d017222e3f61b51f73866e0abd95e3d5059545533c2c29616799b13dfefdc |
Hashes for mkdocs_kroki_plugin-0.8.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d323ef51685e98ad514d5ee6aa95a76195950791b6fbb0496dc515824fa50b7a |
|
MD5 | ac37f1471020fb93f6740cd92228829d |
|
BLAKE2b-256 | c4d9e479281aef27b81c1f10cf9fca5c30f2e6882c67a0796fac4eb8922eca25 |