PLAYG0N/mkdocs-panzoom

MkDocs Plugin to enable pan & zoom on images and mermaid diagrams

Panzoom for MkDocs

This plugin makes use of the panzoom (LICENCE) library by Andrei Kashcha

Live Demo

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)