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.ioEnableBlockDiag
- Enable BlockDiag (and the related Diagrams), default: TrueEnablebpmn
- Enable BPMN, default: TrueEnableExcalidraw
- Enable Excalidraw, default: TrueEnableMermaid
- Enable Mermaid, default: TrueDownloadImages
- Download diagrams from kroki as static assets instead of just creating kroki links, default: FalseDownloadDir
- The asset directory to place downloaded svg images in, default: images/kroki_generated
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
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.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f842c625379de521ed156d3296944ed21596acec59f2f1820d4614db7a2aad0a |
|
MD5 | dc7c0e2b9ef9912f84db4440cb7fdfd3 |
|
BLAKE2b-256 | 1a9df3f9801bcecdd780592a5a3d2bcf969664e64b250afbbb879c38bd064207 |
Close
Hashes for mkdocs_kroki_plugin-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8712b57f961f6b94c019a29a55f30d9e7067bc3fbeb8e7b2c8fbd82ab2144c50 |
|
MD5 | ac926ba15a04017741808d4475beac5a |
|
BLAKE2b-256 | 7ce55b5b6cacb1991f1abc931d1b00c2e0b95e592a4ce288ca6b84ccb62875b9 |