{"library":"mkdocs-panzoom-plugin","title":"MkDocs PanZoom Plugin","description":"The MkDocs PanZoom Plugin is an active MkDocs plugin, currently at version 0.5.2, designed to add pan and zoom functionality to images and Mermaid/D2 diagrams within your MkDocs generated documentation. It enhances user interaction with visual content by allowing navigation and magnification, and it maintains a steady release cadence with recent updates improving performance and features.","language":"python","status":"active","last_verified":"Sat Apr 11","install":{"commands":["pip install mkdocs-panzoom-plugin"],"cli":{"name":"mkdocs","version":"mkdocs, version 1.6.1 from /usr/local/lib/python3.11/site-packages/mkdocs (Python 3.11)"}},"imports":[],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"plugins:\n  - search\n  - panzoom:\n      # Enable pan/zoom for images\n      include_selectors:\n        - \"img\"\n      # Optional: always show the hint (default: false)\n      always_show_hint: true\n      # Optional: set initial zoom level (default: 1.0)\n      initial_zoom_level: 1.2\n      # Optional: enable fullscreen (still in development)\n      full_screen: False\n\n# Required for Mermaid/D2 diagrams with panzoom since v0.4.0\nmarkdown_extensions:\n  - pymdownx.superfences:\n      custom_fences:\n        - name: mermaid\n          class: mermaid\n          format: !!python/name:pymdownx.superfences.fence_code_format\n\nsite_url: https://example.com/your-docs/","lang":"yaml","description":"To activate the plugin, add `panzoom` to your `plugins` list in `mkdocs.yml`. For Mermaid and D2 diagrams to work correctly with pan/zoom since version 0.4.0, you must also configure `pymdownx.superfences` under `markdown_extensions` and define your `site_url`. The example demonstrates enabling pan/zoom for images, showing the hint permanently, setting an initial zoom, and configuring `pymdownx.superfences`.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}