This plugin makes use of the panzoom (LICENCE) library by Andrei Kashcha
pip install mkdocs-panzoom-plugin
Add it to your mkdocs.yml:
plugins:
- search
- panzoom
Warning
Make sure to define the site_url otherwise it won't work!
Example:
site_url: https://playg0n.github.io/mkdocs-panzoom/Examples and usage are available in the docs.
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"This makes the hint on how to use it permanently visible.
plugins:
- panzoom:
always_show_hint: true # default falseThis changes the location of the hint
plugins:
- panzoom:
hint_location: "top" # default bottomOptions for activation key are:
- alt
- ctrl
- shift
- none
plugins:
- panzoom:
key: "ctrl" # default altplugins:
- panzoom:
exclude:
- Path/to/page.mdplugins:
- panzoom:
full_screen: True # default FalseThe structure and some parts are from the enumerate-headings-plugin (LICENCE)
![@github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=64&v=4){kind=small}
