# 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)
> [Live Demo](https://playg0n.github.io/mkdocs-panzoom/)
## Setup
`pip install mkdocs-panzoom-plugin`
Add it to your `mkdocs.yml`:
```yml
plugins:
- search
- panzoom
```
> [!WARNING]
>Make sure to define the `site_url` otherwise it won't work!
>
>**Example**:
>
>```yaml
>site_url: https://playg0n.github.io/mkdocs-panzoom/
>```
## Usage
Examples and usage are available in the [docs](https://playg0n.github.io/mkdocs-panzoom/).
## Config
### Selectors
Mermaid and D2 are included by default, but you can add any arbitrary selector or exclude the default ones.
To enable images add the `img` tag like below.
```yaml
plugins:
- panzoom:
include_selectors:
- .myClass # class in html
- "#myId" # id in html
- "img" # tag in html
exclude_selectors:
- ".mermaid"
- ".d2"
```
### 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))
Raw data
{
"_id": null,
"home_page": "https://github.com/PLAYG0N/mkdocs-panzoom.git",
"name": "mkdocs-panzoom-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "mkdocs zoom pan plugin mermaid images",
"author": "PLAYG0N",
"author_email": "playg0nofficial@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/3b/f2/7e44cd7342ae154bc12b09e605d3be831b652681ff7f2cc3c4617cae5a2d/mkdocs_panzoom_plugin-0.1.3.tar.gz",
"platform": null,
"description": "# Panzoom for MkDocs\n\nThis 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)\n\n> [Live Demo](https://playg0n.github.io/mkdocs-panzoom/)\n\n## Setup\n\n`pip install mkdocs-panzoom-plugin`\n\nAdd it to your `mkdocs.yml`:\n\n```yml\nplugins:\n - search\n - panzoom\n\n```\n\n> [!WARNING]\n>Make sure to define the `site_url` otherwise it won't work!\n>\n>**Example**:\n>\n>```yaml\n>site_url: https://playg0n.github.io/mkdocs-panzoom/\n>```\n\n## Usage\n\nExamples and usage are available in the [docs](https://playg0n.github.io/mkdocs-panzoom/).\n\n## Config\n\n### Selectors\n\nMermaid and D2 are included by default, but you can add any arbitrary selector or exclude the default ones.\nTo enable images add the `img` tag like below.\n\n```yaml\nplugins:\n - panzoom:\n include_selectors:\n - .myClass # class in html\n - \"#myId\" # id in html\n - \"img\" # tag in html\n exclude_selectors:\n - \".mermaid\"\n - \".d2\"\n```\n\n### Exclude Pages\n\n```yml\nplugins:\n - panzoom:\n exclude:\n - Path/to/page.md\n```\n\n### Enable Fullscreen\n\n> [!WARNING]\n>This is still in development!\n\n```yml\nplugins:\n - panzoom:\n full_screen: True # default False\n```\n\n## Credits\n\nThe structure and some parts are from the [enumerate-headings-plugin](https://github.com/timvink/mkdocs-enumerate-headings-plugin) ([LICENCE](./licences/enumerate-headings-plugin))\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MkDocs Plugin to enable pan & zoom on images and mermaid diagrams",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/PLAYG0N/mkdocs-panzoom.git"
},
"split_keywords": [
"mkdocs",
"zoom",
"pan",
"plugin",
"mermaid",
"images"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3a7a9c58273550be49a912ab686485f7faafd67171efcc951163f7b239e9fad5",
"md5": "a638ae006afd3acc5cf66f7530d667a9",
"sha256": "fdc2ae2417e3c6ebe704beb73e90d215fd2a9ab05f816f5e20fb70e40dff86c8"
},
"downloads": -1,
"filename": "mkdocs_panzoom_plugin-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a638ae006afd3acc5cf66f7530d667a9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 20045,
"upload_time": "2024-10-16T17:34:21",
"upload_time_iso_8601": "2024-10-16T17:34:21.010333Z",
"url": "https://files.pythonhosted.org/packages/3a/7a/9c58273550be49a912ab686485f7faafd67171efcc951163f7b239e9fad5/mkdocs_panzoom_plugin-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3bf27e44cd7342ae154bc12b09e605d3be831b652681ff7f2cc3c4617cae5a2d",
"md5": "3c56120cb52a6f7ce51b132784a1b40b",
"sha256": "39acf6f31e859db815bebea1bce73e2983dbc0a6a08fe6bfd779655d56502649"
},
"downloads": -1,
"filename": "mkdocs_panzoom_plugin-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "3c56120cb52a6f7ce51b132784a1b40b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 19307,
"upload_time": "2024-10-16T17:34:22",
"upload_time_iso_8601": "2024-10-16T17:34:22.559407Z",
"url": "https://files.pythonhosted.org/packages/3b/f2/7e44cd7342ae154bc12b09e605d3be831b652681ff7f2cc3c4617cae5a2d/mkdocs_panzoom_plugin-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-16 17:34:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PLAYG0N",
"github_project": "mkdocs-panzoom",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "mkdocs",
"specs": [
[
">=",
"1.1.2"
]
]
},
{
"name": "mkdocs-material",
"specs": [
[
">=",
"8.1.7"
]
]
},
{
"name": "mkdocs-d2-plugin",
"specs": []
}
],
"lcname": "mkdocs-panzoom-plugin"
}
JSON
