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.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b06bb52c245a9ac0f598123ba9f2828a1d20f14259b53b20c4ba0698aeacffff |
|
MD5 | 6aaa02891af6dee58ed64f5a26d12973 |
|
BLAKE2b-256 | 41595c7dd540a73645d46fe23d112d880ed3e736642001e0b9b652ba2556825f |
Close
Hashes for mkdocs_panzoom_plugin-0.0.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9286115e10425a95a5f79a5315264f4a3b2e764c03a75d148dabeb9409e3d2ae |
|
MD5 | 7c0ed9998e1b8f1ea1f339769bd17804 |
|
BLAKE2b-256 | c9d17e5793bcfb77bd60e30bff4440287d2761082717932abb7d1fd6207c00ea |