mkdocs-panzoom-plugin
MkDocs Plugin to enable pan & zoom on images and mermaid diagrams
Decision gist · record as of 2026-08-14
Yes, if you use MkDocs with Mermaid or D2 diagrams and want to give readers interactive zoom/pan without extra tooling. Install friction is low and the MIT license poses no restrictions. The aging maintenance status (235 days since last release) is a minor concern but the repository remains active and there are no known vulnerabilities. Verify that the pymdownx.superfences configuration requirement fits your setup before committing.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires site_url to be defined in mkdocs.yml configuration; as of version 0.4.0, pymdownx.superfences custom_fences configuration for Mermaid is needed for full functionality.
- Low friction install as a pure Python wheel with a single runtime dependency on mkdocs.
- Maintenance status is aging—last release was 235 days ago—but the repository remains active and unarchived with recent commits.
License · maintenance · safety
MIT (permissive) — MIT license permits free use, modification, and distribution with minimal restrictions, making it suitable for both open-source and commercial documentation projects.
last release 2025-12-22 (235 days) · last repo commit 2025-12-22 · 70 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 1,153,941 downloads/mo, #4,291 on PyPI
Alternatives
Verify before relying
pip install mkdocs-panzoom-plugin
Add to mkdocs.yml:
plugins:
- search
- panzoom
Define site_url in mkdocs.yml for the plugin to work.- Whether the 30-day automatic cleanup of localStorage zoom states is configurable or always enforced.
- Compatibility with MkDocs versions beyond those tested during development.
- Performance impact when applied to pages with many diagrams or large images.
What it is and what it does
This MkDocs plugin wraps the panzoom JavaScript library to enable interactive zooming and panning on diagrams and images within your documentation. By default it activates on Mermaid and D2 diagrams, but you can configure it to work on any HTML element via CSS selectors, including standard img tags. Users interact with it by holding a modifier key (Alt by default) and using mouse wheel or drag gestures to zoom and pan.
The plugin automatically persists zoom state and pan position per diagram in browser localStorage, remembering user preferences across page reloads. It supports customization of the activation key, hint display location, initial zoom level, and full-screen mode. The implementation moved to a Markdown extension in version 0.4.0, which improved performance but introduced a requirement for explicit pymdownx.superfences configuration when using Mermaid diagrams.
Use it for
- Enable users to zoom into large architecture diagrams or flowcharts embedded in technical documentation.
- Allow interactive exploration of complex Mermaid diagrams without leaving the documentation page.
- Provide pan-and-zoom capability for high-resolution images or screenshots in API or design documentation.
- Improve readability of dense D2 diagrams by letting readers focus on specific areas.
- Enhance documentation for data visualization or scientific content where detail inspection is valuable.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you use MkDocs with Mermaid or D2 diagrams and want to give readers interactive zoom/pan without extra tooling.
Install friction is low and the MIT license poses no restrictions. The aging maintenance status (235 days since last release) is a minor concern but the repository remains active and there are no known vulnerabilities. Verify that the pymdownx.superfences configuration requirement fits your setup before committing.
Install
mkdocs-panzoom-plugin on PyPI
Before you install
Low friction install as a pure Python wheel with a single runtime dependency on mkdocs. Maintenance status is aging—last release was 235 days ago—but the repository remains active and unarchived with recent commits.
Requires site_url to be defined in mkdocs.yml configuration; as of version 0.4.0, pymdownx.superfences custom_fences configuration for Mermaid is needed for full functionality.
License in practice
MIT license permits free use, modification, and distribution with minimal restrictions, making it suitable for both open-source and commercial documentation projects.
Quickstart
pip install mkdocs-panzoom-plugin
Add to mkdocs.yml:
plugins:
- search
- panzoom
Define site_url in mkdocs.yml for the plugin to work.Verify before relying
- Whether the 30-day automatic cleanup of localStorage zoom states is configurable or always enforced.
- Compatibility with MkDocs versions beyond those tested during development.
- Performance impact when applied to pages with many diagrams or large images.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.7 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagemkdocs |
| Maintenance | Aging 235 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 1,153,941 / month, #4,291 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Intended Audience :: DevelopersIntended Audience :: Information TechnologyLicense :: OSI Approved :: MIT LicenseProgramming Language :: PythonProgramming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.8Programming Language :: Python :: 3.9 |
Evidence: mkdocs_panzoom_plugin-0.5.2-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 image zoom pan”
- mkdocs-panzoom-pluginAdds interactive pan and zoom functionality to images and diagrams…
- mkdocs-drawioA MkDocs plugin that embeds interactive Drawio diagrams directly into…
- mkdocs-glightboxA MkDocs plugin that automatically wraps images in a lightbox viewer…
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-mermaid2-plugin · mkdocs-glightbox · mkdocs-drawio · mkdocs-kroki-plugin · sphinxcontrib-mermaid · mermaid-py · mkdocs-video · mkdocs-include-markdown-plugin · mkdocs-awesome-pages-plugin · mkdocs-llmstxt