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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c01044cde2d7f10d93bf31c2c2432b47eacaeb8a0728b56330c2efa11bd2ba1e |
|
MD5 | 9c2154e14170eeecaa73a049adf187fb |
|
BLAKE2b-256 | 9cb71381a6e4a1b2993e50156bb2e9e0e637e6dc951c31de85a3bf556c98fdf5 |
Close
Hashes for mkdocs_panzoom_plugin-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6eff615fa76b2986f121f2bf471d118bde285c1fd8961ecc69842706c4180dcf |
|
MD5 | 1fd88626ad93e8688a807119dd5b82f9 |
|
BLAKE2b-256 | fd69d64ff5895b1fb5951a3c3071cd0ba684131f7101333d7c0c1589310f006f |