MkDocs Plugin to enable pan & zoom on images and mermaid diagrams
Project description
Panzoom for MkDocs
This plugin makes use of the panzoom (LICENCE) library by Andrei Kashcha
Setup
pip install mkdocs-panzoom-plugin
Add it to your mkdocs.yml
:
plugins:
- search
- panzoom
Usage
Examples and usage are available in the docs.
Config
Mermaid
This enables panzoom on mermaid diagrams.
plugins:
mermaid: true # default true
Images
This enables panzoom on images.
plugins:
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)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocs_panzoom_plugin-0.0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b436b86b78e40c1a229b3728036cec14c3700e7796ad5d20ad001ee093bd46b |
|
MD5 | 46a93b311a1a07e7d6482e7af74a9c28 |
|
BLAKE2b-256 | ac91b9ed386f274e971c0270549f90de6a82e9261be1ab69d9b754cc5b9be43f |
Close
Hashes for mkdocs_panzoom_plugin-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a35f3730bd56c30ab86052a145473a72903422699d35552467aa64ff1299a74e |
|
MD5 | 2826581fd732870e77da8f8e51593300 |
|
BLAKE2b-256 | 98d45850de8e5fcdacd8adabbb3b747739fc0ce94aa3dd45e50540d03a5c1929 |