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.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee49cccbe24d1bf3cf62cac8fabdafdf0f0a7e6954747e90fe0fbfe50ed8258a |
|
MD5 | 535c67d826b04fd149af60253ac82e6a |
|
BLAKE2b-256 | 7b9ff836f76225f084c1e9014ba0cefd5d2f677adcc51f6a4733ccf47f115b2c |
Close
Hashes for mkdocs_panzoom_plugin-0.0.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ac874c15a238f3ecec5bc93926862486445b8e4c959f312f3d1c7ade4924a486 |
|
MD5 | 5f2168b1b1f09a2df093e454acdee127 |
|
BLAKE2b-256 | dd903c79f8ffc9c6f2594b7e5bbe37d75e4aead50c496c435db76b9992e0af92 |