mkdocs-drawio
MkDocs plugin for embedding Drawio files
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 real problem for documentation sites that need interactive diagrams. MIT licensing removes legal friction. Install it if your MkDocs project needs embedded Drawio diagrams; the dependency footprint is small and the setup is straightforward.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.9 or newer and an active MkDocs project with mkdocs.yml configuration.
- Low friction installation as a pure Python wheel.
- Actively maintained with a recent release; repository shows 46 stars and was last updated 2026-07-25.
License · maintenance · safety
MIT (permissive) — MIT license is permissive, allowing use in commercial and private projects with minimal restrictions.
last release 2026-07-25 (20 days) · last repo commit 2026-07-25 · 46 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 160,093 downloads/mo, #10,673 on PyPI
Alternatives
Verify before relying
pip install mkdocs-drawio
Then add to mkdocs.yml:
plugins:
- drawio
In markdown:
{ page="Page-2" }- Whether the plugin works with all MkDocs themes or only specific ones (Material theme integration is documented, but compatibility with others is unclear).
- Performance impact when embedding many diagrams or large .drawio files in a single documentation site.
What it is and what it does
mkdocs-drawio is a MkDocs plugin that transforms .drawio image references in your markdown into interactive, embedded diagram viewers. Instead of static image files, your documentation displays live Drawio diagrams that readers can zoom, pan, interact with, and optionally open in the full editor. The plugin hooks into MkDocs' post-page generation event, scans for .drawio image tags, and replaces them with mxgraph HTML blocks that render the diagram content inline.
The plugin supports multi-page diagrams (selecting specific pages via markdown attributes), custom viewer URLs for air-gapped environments, and integrates with Material theme's instant-loading feature. It depends on requests, jinja2, beautifulsoup4, lxml, and pypng to parse and transform the generated HTML. Configuration options control toolbar visibility, dark mode, lightbox behavior, and diagram interactivity.
Use it for
- Embed architecture diagrams, flowcharts, or UX wireframes directly in API or technical documentation so readers can interact without downloading files.
- Create multi-page diagram documents where different pages show different views of the same system, selectable within the documentation.
- Set up documentation in air-gapped environments by self-hosting the Drawio viewer JavaScript and configuring a custom viewer URL.
- Enable live diagram editing within documentation sites by toggling the edit option, allowing readers to modify and explore diagrams interactively.
- Integrate diagrams into tabbed documentation layouts using pymdownx.tabbed with the provided JavaScript workaround.
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 real problem for documentation sites that need interactive diagrams. MIT licensing removes legal friction. Install it if your MkDocs project needs embedded Drawio diagrams; the dependency footprint is small and the setup is straightforward.
Install
mkdocs-drawio on PyPI
Before you install
Low friction installation as a pure Python wheel. Actively maintained with a recent release; repository shows 46 stars and was last updated 2026-07-25. Requires Python 3.9 or newer and depends on common, well-established packages (requests, jinja2, beautifulsoup4, lxml, mkdocs, pypng).
Requires Python 3.9 or newer and an active MkDocs project with mkdocs.yml configuration.
License in practice
MIT license is permissive, allowing use in commercial and private projects with minimal restrictions.
Quickstart
pip install mkdocs-drawio
Then add to mkdocs.yml:
plugins:
- drawio
In markdown:
{ page="Page-2" }Verify before relying
- Whether the plugin works with all MkDocs themes or only specific ones (Material theme integration is documented, but compatibility with others is unclear).
- Performance impact when embedding many diagrams or large .drawio files in a single documentation site.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release <4.0,>=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 6 packagesrequestsjinja2beautifulsoup4lxmlmkdocspypng |
| Maintenance | Actively maintained 20 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 160,093 / month, #10,673 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
Evidence: mkdocs_drawio-1.16.3-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 › “mkdocs diagram embedding”
- mkdocs-drawioA MkDocs plugin that embeds interactive Drawio diagrams directly into…
- mkdocs-kroki-pluginA MkDocs plugin that converts Kroki diagram syntax in Markdown code…
- mkdocs-mermaid2-pluginA MkDocs plugin that renders Mermaid diagram syntax embedded in…
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-glightbox · mkdocs-kroki-plugin · mkdocs-mermaid2-plugin · sphinxcontrib-drawio · mkdocs-panzoom-plugin · mkdocs-video · mkdocs-render-swagger-plugin · neoteroi-mkdocs · mkdocs-plugin-inline-svg · mkdocs-material-extensions