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
[!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)
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.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ab851cb29168d657da6c38101364d58d10ffe9a909445df08cf71ce97310c8f |
|
MD5 | 008af83f34b16d67f4e2801ff4908661 |
|
BLAKE2b-256 | a5288fb48ec995e9781039c9a56d2d537b53af262293a05af4c66110260d129d |
Close
Hashes for mkdocs_panzoom_plugin-0.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1e83e0722a4f922dae143f7b620aece0b43372c25561d9a25a70d21d91cfb44 |
|
MD5 | 646b164ec389e9fac8902d4c42e9d6d9 |
|
BLAKE2b-256 | bcf1d4766f7546a6b68535b491a673ebf8322691da33777f6aaaa82e4ebfa233 |