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.io
EnableBlockDiag - Enable BlockDiag (and the related Diagrams), default: True
Enablebpmn - Enable BPMN, default: True
EnableExcalidraw - Enable Excalidraw, default: True
EnableMermaid - Enable Mermaid, default: True
DownloadImages - Download diagrams from kroki as static assets instead of just creating kroki links, default: False
DownloadDir - 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"];
}
```

Pre-Release-Versions

Install the newest pre-release version using pip:

pip install -i https://test.pypi.org/simple/ mkdocs-kroki-plugin

Release files for mkdocs-kroki-plugin 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-kroki-plugin 0.2.0
File	Size	Uploaded
mkdocs-kroki-plugin-0.2.0.tar.gz	4.4 kB	Jul 13, 2021	Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-kroki-plugin 0.2.0
File	Interpreter	ABI	Platform	Reset
mkdocs_kroki_plugin-0.2.0-py3-none-any.whl 4.7 kB Jul 13, 2021	Python 3	none	any	Details

Total release size: 9.1 kB

Release files / mkdocs-kroki-plugin-0.2.0.tar.gz

Download URL	mkdocs-kroki-plugin-0.2.0.tar.gz
Size	4.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`d6179b4d084acb4dce9ba639ee0bb103477b18d0d54f12e4d5510b9adc1425b3`
BLAKE2b-256 checksum How to use checksums	`e652ba6d9ab6ae18383ba715e9be245cbbfbf53779f6ba8c8f820a12ca319488`
Upload date	Jul 13, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6`

Release files / mkdocs_kroki_plugin-0.2.0-py3-none-any.whl

Download URL	mkdocs_kroki_plugin-0.2.0-py3-none-any.whl
Size	4.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`7af511f6c4acef1f5d56ed7ac2aff8ad89c5c2ab286d2c58bc168ec2b5e43634`
BLAKE2b-256 checksum How to use checksums	`35fb35c3a215cb35e953983862305a92fa4bf5336433fcb269400dd767d594f8`
Upload date	Jul 13, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6`