Registry / web-framework / mkdocs-drawio

mkdocs-drawio

library1.16.1pypypiunverified

MkDocs plugin for embedding Draw.io (diagrams.net) diagrams in your documentation. It supports .drawio, .dio, and .drawio.svg files, with features like dark mode, custom toolbars, and page navigation. Current version: 1.15.0, actively maintained with regular releases.

web-framework

pip install mkdocs-drawio

github ↗package ↗

INSTALL

IMPORT

SIG · MKDOCS-DRAWIO

mkdocs-drawio

web-frameworkpythonv1.16.1

Install

4.2s avg

Import

—

Disk

49MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.16.1 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 49.7MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 4.2s · import 0.000s · 51MB

49MB installed

● package 49MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

mkdocs_drawio

✓ mkdocs_drawio (imported automatically as MkDocs plugin)

✗ import mkdocs_drawio

This is a MkDocs plugin, not a Python module to import directly. It is configured in mkdocs.yml.

Add the drawio plugin to your MkDocs configuration. Then place .drawio files in your docs directory and reference them with standard Markdown image syntax like `![Diagram](diagram.drawio)`.

# mkdocs.yml plugins: - drawio

Debug

Known issues

breakingMkDocs 1.6+ has breaking changes in plugin APIs; older versions of mkdocs-drawio may not work. Upgrade to at least v1.12.0 for MkDocs 1.6 support.

fix

Update to mkdocs-drawio >= 1.12.0.

affects: <1.12.0

gotchaDiagram files must be placed inside the docs directory. Files outside will not be processed.

fix

Move .drawio files into your docs folder (or a subfolder).

affects: all

deprecatedThe old `drawio-file` configuration key is deprecated in favor of `drawio` in mkdocs.yml.

fix

Use `plugins: [drawio]` instead of `plugins: [drawio-file]`.

affects: <1.0.0

gotchaDark mode requires the drawio toolbox to have the 'dark mode' option enabled. It does not automatically match the browser/system theme.

fix

Add `dark_mode: true` under the drawio plugin configuration in mkdocs.yml.

affects: >=1.11.0

Upgrade

Version history

1.16.1latest on PyPI · released May 18, 2026

Audit

Dependencies

mkdocsrequiredRequired plugin framework

lxmlrequiredXML/SVG parsing for diagram files

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/tuunit/mkdocs-drawio ↗

packagehttps://pypi.org/project/mkdocs-drawio/ ↗