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: TrueEnableDiagramsnet
- Enable diagrams.net (draw.io), default: FalseHttpMethod
- Http method to use (GET
orPOST
), default:GET
(Note: you have to enableDownloadImages
if you want to usePOST
!)DownloadImages
- Download diagrams from kroki as static assets instead of just creating kroki links, default: FalseDownloadDir
- The asset directory to place downloaded images in, default: images/kroki_generatedFileTypes
- File types you want to use, default: [svg], (Note: not all file formats works 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.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc770d12098a25b648eb0de0ba3ccc3979c5ed5e011c74382e58407ae813c59f |
|
MD5 | 4aaca41d5f05096b048825a9a18919df |
|
BLAKE2b-256 | 25924096cc3f2ab3be88987b4b1ef430f34cabb85519cd86edc855be0e6472df |
Hashes for mkdocs_kroki_plugin-0.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6f2fc16ea723f47bce02536833680e3db6638101b031480fda1e5ae4a920cfbc |
|
MD5 | c81c2c58ce89ae8fa320b5c8667dcb52 |
|
BLAKE2b-256 | 4c7be6006fd178887c2d0964ddaacbc56465b3543181bd9975aee73a7bb97f9e |