Metadata-Version: 2.1
Name: mkdocs-panzoom-plugin
Version: 0.0.5
Summary: MkDocs Plugin to enable pan & zoom on images and mermaid diagrams
Home-page: https://github.com/PLAYG0N/mkdocs-panzoom.git
Author: PLAYG0N
Author-email: playg0nofficial@gmail.com
License: MIT
Keywords: mkdocs zoom pan plugin mermaid images
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs>=1.0.4
Requires-Dist: beautifulsoup4>=4.9.0

# Panzoom for MkDocs

This plugin makes use of the [panzoom](https://github.com/anvaka/panzoom) ([LICENCE](./mkdocs_panzoom_plugin/panzoom/LICENCE)) library by [Andrei Kashcha](https://github.com/anvaka)

## Setup

`pip install mkdocs-panzoom-plugin`

Add it to your `mkdocs.yml`:

```yml
plugins:
  - search
  - panzoom

```

## Usage

Examples and usage are available in the [docs](https://playg0n.github.io/mkdocs-panzoom/).

## Config

### Mermaid

This enables panzoom on mermaid diagrams.

```yml
plugins:
  mermaid: true # default true
```

### Images

This enables panzoom on images.

```yml
plugins:
  images: true # default true
```
### Exclude Pages

```yml
plugins:
  - panzoom:
      exclude:
        - Path/to/page.md
```

### Enable Fullscreen

!!! warning

    This is still in development!

```yml
plugins:
  - panzoom:
      full_screen: True # default False
```

## Credits

The structure and some parts are from the [enumerate-headings-plugin](https://github.com/timvink/mkdocs-enumerate-headings-plugin) ([LICENCE](./licences/enumerate-headings-plugin))
