# 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
### Mermaid
This enables panzoom on mermaid diagrams.
```yml
plugins:
- panzoom:
mermaid: true # default true
```
### Images
This enables panzoom on images.
```yml
plugins:
- panzoom:
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))
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/4d/ae/f388356634792bc00ca31d5931b8babbb86550e3f4aada029eed45692b65/mkdocs_panzoom_plugin-0.1.1.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### Mermaid\n\nThis enables panzoom on mermaid diagrams.\n\n```yml\nplugins:\n - panzoom:\n mermaid: true # default true\n```\n\n### Images\n\nThis enables panzoom on images.\n\n```yml\nplugins:\n - panzoom:\n images: true # default true\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.1",
"project_urls": {
"Homepage": "https://github.com/PLAYG0N/mkdocs-panzoom.git"
},
"split_keywords": [
"mkdocs",
"zoom",
"pan",
"plugin",
"mermaid",
"images"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8a6db571438069572520743fc893e124470be8bdbbbbafb061996d5f53cc4631",
"md5": "306119481903c42c3b62b80846d7c1a1",
"sha256": "28d6777b509703b023e3f2cf3fdbc63eb3d746a088aac78d16f3ba0f54ba189a"
},
"downloads": -1,
"filename": "mkdocs_panzoom_plugin-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "306119481903c42c3b62b80846d7c1a1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 19503,
"upload_time": "2024-09-18T18:02:05",
"upload_time_iso_8601": "2024-09-18T18:02:05.459348Z",
"url": "https://files.pythonhosted.org/packages/8a/6d/b571438069572520743fc893e124470be8bdbbbbafb061996d5f53cc4631/mkdocs_panzoom_plugin-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4daef388356634792bc00ca31d5931b8babbb86550e3f4aada029eed45692b65",
"md5": "6cb91688fa7808966ac3312f7546c9c7",
"sha256": "68c7b04041a9b413c3ffea5ebf9278fed96142fed741270222fa1a5429e32fdb"
},
"downloads": -1,
"filename": "mkdocs_panzoom_plugin-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "6cb91688fa7808966ac3312f7546c9c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 18680,
"upload_time": "2024-09-18T18:02:06",
"upload_time_iso_8601": "2024-09-18T18:02:06.854535Z",
"url": "https://files.pythonhosted.org/packages/4d/ae/f388356634792bc00ca31d5931b8babbb86550e3f4aada029eed45692b65/mkdocs_panzoom_plugin-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-18 18:02:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PLAYG0N",
"github_project": "mkdocs-panzoom",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "mkdocs-panzoom-plugin"
}
JSON
