Description:

mkdocspanzoomplugin 0.0.9

Panzoom for MkDocs
This plugin makes use of the panzoom (LICENCE) library by Andrei Kashcha

Live Demo

Setup
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/


Usage
Examples and usage are available in the docs.
Config
Mermaid
This enables panzoom on mermaid diagrams.
plugins:
- panzoom:
mermaid: true # default true

Images
This enables panzoom on images.
plugins:
- panzoom:
images: true # default true

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

Enable Fullscreen

[!WARNING]
This is still in development!

plugins:
- panzoom:
full_screen: True # default False

Credits
The structure and some parts are from the enumerate-headings-plugin (LICENCE)

License

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Share

• Share on Facebook
• Share on Twitter