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.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 68c7b04041a9b413c3ffea5ebf9278fed96142fed741270222fa1a5429e32fdb |
|
MD5 | 6cb91688fa7808966ac3312f7546c9c7 |
|
BLAKE2b-256 | 4daef388356634792bc00ca31d5931b8babbb86550e3f4aada029eed45692b65 |
Close
Hashes for mkdocs_panzoom_plugin-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28d6777b509703b023e3f2cf3fdbc63eb3d746a088aac78d16f3ba0f54ba189a |
|
MD5 | 306119481903c42c3b62b80846d7c1a1 |
|
BLAKE2b-256 | 8a6db571438069572520743fc893e124470be8bdbbbbafb061996d5f53cc4631 |