Home¶

This plugin makes use of the panzoom library by Andrei Kashcha

Setup¶

pip install mkdocs-panzoom-plugin

Add it to your mkdocs.yaml:

plugins:
  - search
  - panzoom

site_url: https://playg0n.github.io/mkdocs-panzoom/

Usage¶

Examples and usage are available in the docs.

Config¶

Selectors¶

Mermaid and D2 are included by default, but you can add any arbitrary selector or exclude the default ones. To enable images add the img tag like below.

plugins:
  - panzoom:
      include_selectors:
        - .myClass # class in html
        - "#myId" # id in html
        - "img" # tag in html
      exclude_selectors:
        - ".mermaid"
        - ".d2"

Always show hint¶

This makes the hint on how to use it permanently visible.

plugins:
  - panzoom:
      always_show_hint: true # default false

Use different key¶

Options for activation key are:

• alt
• ctrl
• shift
• none

plugins:
  - panzoom:
      key: "ctrl" # default alt

Exclude Pages¶

plugins:
  - panzoom:
      exclude:
        - Path/to/page.md

Enable Fullscreen¶

plugins:
  - panzoom:
      full_screen: True # default False

Credits¶

The structure and some parts are from the enumerate-headings-plugin