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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b2cec2c9cdb912f318c3027bf8897e814e5be62445f7eb60267446c2fb912b8 |
|
MD5 | 03e8c6bfd97ed552cdcc6fa0a9263b7c |
|
BLAKE2b-256 | 4edbad06323ca2b9799b338b612331ea170bc3681e2cf2aced74f400b9644ada |
Close
Hashes for mkdocs_panzoom_plugin-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7bdfd4e77f586a834a2de410258b42717ae31ff4314ea8c150380536abb3361e |
|
MD5 | 01f2ec40622c35b201ba85364d537747 |
|
BLAKE2b-256 | 0e66c47e307abc628c48bfb7dba27ae79160a2786484c0cd57f919134bec81dd |