{"id":17470783,"url":"https://github.com/playg0n/mkdocs-panzoom","last_synced_at":"2025-04-14T22:36:58.018Z","repository":{"id":255392399,"uuid":"845699461","full_name":"PLAYG0N/mkdocs-panzoom","owner":"PLAYG0N","description":"MkDocs Plugin to enable pan \u0026 zoom on images and mermaid/d2 diagrams","archived":false,"fork":false,"pushed_at":"2025-03-26T17:25:59.000Z","size":7369,"stargazers_count":27,"open_issues_count":3,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-26T18:30:42.371Z","etag":null,"topics":["d2","diagram","mermaid","mkdocs","pan","zoom"],"latest_commit_sha":null,"homepage":"https://playg0n.github.io/mkdocs-panzoom/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PLAYG0N.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-21T18:53:29.000Z","updated_at":"2025-03-26T17:25:40.000Z","dependencies_parsed_at":"2024-09-09T20:55:22.741Z","dependency_job_id":"022a70f7-fe85-4db6-ae1a-e2cbf54031c1","html_url":"https://github.com/PLAYG0N/mkdocs-panzoom","commit_stats":null,"previous_names":["playg0n/mkdocs-panzoom"],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PLAYG0N%2Fmkdocs-panzoom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PLAYG0N%2Fmkdocs-panzoom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PLAYG0N%2Fmkdocs-panzoom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PLAYG0N%2Fmkdocs-panzoom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PLAYG0N","download_url":"https://codeload.github.com/PLAYG0N/mkdocs-panzoom/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248974667,"owners_count":21192186,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["d2","diagram","mermaid","mkdocs","pan","zoom"],"created_at":"2024-10-18T16:10:13.382Z","updated_at":"2025-04-14T22:36:57.997Z","avatar_url":"https://github.com/PLAYG0N.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 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\u003e [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\u003e [!WARNING]\n\u003eMake sure to define the `site_url` otherwise it won't work!\n\u003e\n\u003e**Example**:\n\u003e\n\u003e```yaml\n\u003esite_url: https://playg0n.github.io/mkdocs-panzoom/\n\u003e```\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\u003e [!WARNING]\n\u003eThis 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplayg0n%2Fmkdocs-panzoom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplayg0n%2Fmkdocs-panzoom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplayg0n%2Fmkdocs-panzoom/lists"}