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: TrueHttpMethod
- 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"];
}
```
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.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed5e57fd53e790ce0b844c2de5cacc5ada635820941fc76b9f36903784e5d74b |
|
MD5 | aa6705a8f2b35b78d48d5c6313cf1c83 |
|
BLAKE2b-256 | c992b411951669e800732b8df29f28b12858646c551089d6fee8e977be0544fc |
Close
Hashes for mkdocs_kroki_plugin-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ac1c32188b50810ea772e184c90195b177e290595a69bb24790f7737d1fbca6e |
|
MD5 | c5e251058107089ba2567e09f7f5ecaf |
|
BLAKE2b-256 | 55cc03d54432fdc51cbc93674a6f411aa4537d7fe2928610dbdf8e06c40c9eb2 |