mkdocs-kroki-plugin
MkDocs plugin for Kroki-Diagrams
Decision gist · record as of 2026-08-14
Yes. The plugin is actively maintained, has no known vulnerabilities, installs with low friction, and solves a clear problem—embedding diagrams in MkDocs without manual image management. MIT licensing removes legal friction. Install it if you use MkDocs and want to include Kroki diagrams; the only prerequisite is access to a Kroki server and Python 3.10+.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later; requires a running Kroki server (public instance at https://kroki.io or self-hosted).
- Low friction: pure Python wheel with five runtime dependencies (mkdocs, httpx, defusedxml, properdocs, result).
- Active maintenance with a recent release 123 days ago and ongoing commits.
License · maintenance · safety
MIT (permissive) — MIT license permits free use, modification, and distribution with minimal restrictions—suitable for both open-source and proprietary projects.
last release 2026-04-13 (123 days) · last repo commit 2026-06-22 · 63 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 84,348 downloads/mo, #14,005 on PyPI
Alternatives
Verify before relying
pip install mkdocs-kroki-plugin
# In mkdocs.yml:
plugins:
- kroki:
server_url: 'https://kroki.io'
# In your Markdown:
```kroki-blockdiag
blockdiag {
A -> B -> C;
}
```- Whether the plugin supports all Kroki diagram types equally or if some have known limitations.
- Performance impact of caching strategies on large documentation builds with hundreds of diagrams.
- Compatibility with MkDocs themes that use custom HTML rendering or CSS frameworks.
What it is and what it does
mkdocs-kroki-plugin bridges MkDocs and Kroki, a universal diagram-rendering service. You write diagram syntax (BlockDiag, BPMN, Mermaid, Excalidraw, and others) inside Markdown code fences tagged with `kroki-`, and the plugin renders them server-side, embedding the results as images or SVG objects in your built documentation. It handles HTTP requests to a Kroki server (public or self-hosted), caches rendered diagrams to speed up rebuilds during local development, and supports configuration for output format, styling, timeouts, and display options like width and alignment.
The plugin depends on mkdocs as its framework, httpx for HTTP requests, and defusedxml for safe XML parsing. It targets modern Python (3.10–3.14) and is in Beta status. Maintenance is active, with recent releases and ongoing commits. No known security vulnerabilities are recorded.
Use it for
- Embed architecture diagrams, flowcharts, and sequence diagrams directly in API or system documentation without external image files.
- Generate BPMN process diagrams in technical documentation that stay in sync with your source code repository.
- Create Mermaid flowcharts and state diagrams in MkDocs sites, leveraging Kroki's rendering instead of client-side JavaScript.
- Build documentation with theme-aware diagram styling (light/dark mode backgrounds and colors) using the plugin's style configuration.
- Speed up local documentation builds by caching rendered diagrams, avoiding re-rendering on every file save during `mkdocs serve`.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
The plugin is actively maintained, has no known vulnerabilities, installs with low friction, and solves a clear problem—embedding diagrams in MkDocs without manual image management. MIT licensing removes legal friction. Install it if you use MkDocs and want to include Kroki diagrams; the only prerequisite is access to a Kroki server and Python 3.10+.
Install
mkdocs-kroki-plugin on PyPI
Before you install
Low friction: pure Python wheel with five runtime dependencies (mkdocs, httpx, defusedxml, properdocs, result). Active maintenance with a recent release 123 days ago and ongoing commits.
Requires Python 3.10 or later; requires a running Kroki server (public instance at https://kroki.io or self-hosted).
License in practice
MIT license permits free use, modification, and distribution with minimal restrictions—suitable for both open-source and proprietary projects.
Quickstart
pip install mkdocs-kroki-plugin
# In mkdocs.yml:
plugins:
- kroki:
server_url: 'https://kroki.io'
# In your Markdown:
```kroki-blockdiag
blockdiag {
A -> B -> C;
}
```Verify before relying
- Whether the plugin supports all Kroki diagram types equally or if some have known limitations.
- Performance impact of caching strategies on large documentation builds with hundreds of diagrams.
- Compatibility with MkDocs themes that use custom HTML rendering or CSS frameworks.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 5 packagesdefusedxmlhttpxmkdocsproperdocsresult |
| Maintenance | Actively maintained 123 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 84,348 / month, #14,005 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 4 - BetaFramework :: MkDocsIntended Audience :: DevelopersIntended Audience :: Information TechnologyIntended Audience :: Science/ResearchLicense :: OSI Approved :: MIT LicenseProgramming Language :: PythonProgramming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: DocumentationTopic :: Software Development :: Documentation |
Evidence: mkdocs_kroki_plugin-1.6.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “kroki diagram rendering”
- mkdocs-kroki-pluginA MkDocs plugin that converts Kroki diagram syntax in Markdown code…
- plantuml-markdownA Markdown extension that converts PlantUML diagram syntax into…
- sphinxcontrib-blockdiagA Sphinx extension that embeds block diagrams into documentation by…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also mkdocs-drawio · mkdocs-mermaid2-plugin · mkdocs-panzoom-plugin · blockdiag · mkdocs-video · mkdocs-include-markdown-plugin · neoteroi-mkdocs · mkdocs-render-swagger-plugin · markdown-exec · sphinxcontrib-blockdiag