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: 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) |
FileTypes |
File types you want to use, default: [svg] , (Note: not all file formats work with all diagram types https://kroki.io/#support) |
- kroki:
FileTypes:
- png
- svg
FileTypeOverrides
- Overrides for specific diagrams to set the desired file type default: None,
- kroki:
FileTypeOverrides:
mermaid: png
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
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.7.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ad7b07384a90151f0b8f0dc64c43691ea017994221bccd3431c9f278d61055e |
|
MD5 | 63a1db7db05625615fde6cbfbc259c1a |
|
BLAKE2b-256 | ca5205f5acc136d70b0f1754571869581f1cd3400c05faf475acdb0b3b53d938 |
Hashes for mkdocs_kroki_plugin-0.7.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e6731592469717dc77d704e6a8f8773d3d9423e5e7690411ad2422ad2b0a403b |
|
MD5 | 1bb8ab70dc5f5a24a188db8f925fc0b8 |
|
BLAKE2b-256 | f7e806f14fef204b4639d8dbd0b441747cf1d1984895e3c49125515c26e8eb26 |