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.ioEnableBlockDiag- Enable BlockDiag (and the related Diagrams), default: TrueEnablebpmn- Enable BPMN, default: TrueEnableExcalidraw- Enable Excalidraw, default: TrueEnableMermaid- Enable Mermaid, default: True
Usage
Use code-fences with a tag of kroki-<Module> to replace the code with the wanted diagram.
Example for BlockDiag:
```kroki-blockdiag
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
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-kroki-plugin 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs-kroki-plugin-0.1.0.tar.gz | 3.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_kroki_plugin-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 7.7 kB
Release files / mkdocs-kroki-plugin-0.1.0.tar.gz
| Download URL | mkdocs-kroki-plugin-0.1.0.tar.gz |
|---|---|
| Size | 3.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
98c1ceb6c55adeb1548b418f532cb84691a2fe6bc70b8e03b39187d2355a1915
|
|
BLAKE2b-256 checksum How to use checksums |
dcedf468b6b053c2159bb2a5bf1c2a728fec799e241727fca40b2ba0a286da41
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.2
|
Release files / mkdocs_kroki_plugin-0.1.0-py3-none-any.whl
| Download URL | mkdocs_kroki_plugin-0.1.0-py3-none-any.whl |
|---|---|
| Size | 4.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8c44b4d4ffc314339035ae2548c133249caaf09bd710c4e9b770a6587ccba3b2
|
|
BLAKE2b-256 checksum How to use checksums |
6a93b8b07b9426ae9b1d9d92ad4be4ba3eb7591afd41801f0810e995c5fbe155
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.2
|
