{"id":15188425,"url":"https://github.com/jakubandrysek/mkdocs-resize-images","last_synced_at":"2025-09-11T12:31:38.974Z","repository":{"id":177621282,"uuid":"660628493","full_name":"JakubAndrysek/mkdocs-resize-images","owner":"JakubAndrysek","description":"✂️ MkDocs plugin to resize images according to the configuration","archived":false,"fork":false,"pushed_at":"2023-11-04T00:19:19.000Z","size":1212,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-17T16:45:18.147Z","etag":null,"topics":["images","mkdoc","mkdocs-material","mkdocs-plugin","plugin","resize-images"],"latest_commit_sha":null,"homepage":"https://resize.kubaandrysek.cz/","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/JakubAndrysek.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},"funding":{"github":["JakubAndrysek"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2023-06-30T12:49:55.000Z","updated_at":"2024-11-27T05:48:46.000Z","dependencies_parsed_at":null,"dependency_job_id":"6e14f34e-8943-40ac-9d24-46385007e5d0","html_url":"https://github.com/JakubAndrysek/mkdocs-resize-images","commit_stats":null,"previous_names":["jakubandrysek/mkdocs-resize-images"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/JakubAndrysek/mkdocs-resize-images","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakubAndrysek%2Fmkdocs-resize-images","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakubAndrysek%2Fmkdocs-resize-images/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakubAndrysek%2Fmkdocs-resize-images/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakubAndrysek%2Fmkdocs-resize-images/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JakubAndrysek","download_url":"https://codeload.github.com/JakubAndrysek/mkdocs-resize-images/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakubAndrysek%2Fmkdocs-resize-images/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274633284,"owners_count":25321374,"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","status":"online","status_checked_at":"2025-09-11T02:00:13.660Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["images","mkdoc","mkdocs-material","mkdocs-plugin","plugin","resize-images"],"created_at":"2024-09-27T19:05:14.652Z","updated_at":"2025-09-11T12:31:38.611Z","avatar_url":"https://github.com/JakubAndrysek.png","language":"Python","funding_links":["https://github.com/sponsors/JakubAndrysek"],"categories":[],"sub_categories":[],"readme":"# MkDocs Resize Images Plugin\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://hits.seeyoufarm.com\"\u003e\u003cimg src=\"https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FJakubAndrysek%2Fmkdocs-resize-images\u0026count_bg=%2379C83D\u0026title_bg=%23555555\u0026icon=\u0026icon_color=%23E7E7E7\u0026title=hits\u0026edge_flat=true\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/JakubAndrysek/mkdocs-resize-images/blob/main/LICENSE\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/github/license/JakubAndrysek/mkdocs-resize-images?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://pypi.org/project/mkdocs-resize-images/\" target=\"_blank\"\u003e\u003cimg alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/mkdocs-resize-images?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/JakubAndrysek/mkdocs-resize-images/stargazers\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/JakubAndrysek/mkdocs-resize-images?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/JakubAndrysek/mkdocs-resize-images/forks\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/github/forks/JakubAndrysek/mkdocs-resize-images?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/JakubAndrysek/mkdocs-resize-images/issues\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/github/issues/JakubAndrysek/mkdocs-resize-images?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/JakubAndrysek/mkdocs-resize-images/discussions\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/github/discussions/JakubAndrysek/mkdocs-resize-images?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://pypistats.org/packages/mkdocs-resize-images\" target=\"_blank\"\u003e\u003cimg src=\"https://static.pepy.tech/personalized-badge/mkdocs-resize-images?period=month\u0026units=international_system\u0026left_color=black\u0026right_color=orange\u0026left_text=Downloads\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nThis MkDocs plugin finds all folders with a certain name, by default `assets-large`, resizes all images in those folders according to the plugin configuration.\nThen saves the resized images in a different folder, by default `assets`.\nThe plugin also supports caching: if a file has not changed since the last time the plugin ran, it won't be processed again.\n\n## Installation\n\nInstall the plugin using pip from [PyPI](https://pypi.org/project/mkdocs-resize-images/):\n\n```bash\npip install mkdocs-resize-images\n```\n\nActivate the plugin in `mkdocs.yml`:\n\n```yaml\nplugins:\n  - search\n  - resize-images\n```\n\nCreate `.gitignore` file in your project root directory and add the following line to it:\n\n```bash\nassets-large # or whatever you have set as source-dir\n\n.resize-hash # if you have enabled caching\n```\n\n\n## Usage\n\nBy default, the plugin will look for images in all directories named assets-large, resize them to 800x600 pixels, and then save the resized images in assets directories in the same parent directories as the assets-large directories.\n\nYou can configure the plugin in your mkdocs.yml:\n\n```yaml\nplugins:\n  - search\n  - resize-images:\n      source-dir: assets-large\n      target-dir: assets\n      enable_cache: True\n      size: [800, 600]\n      extensions: ['.jpg', '.jpeg', '.png', '.gif', '.svg']\n```\n\n`source-dir`: The name of the directories to search for images to resize. Default is `assets-large`.\n\n`target-dir`: The name of the directories to save the resized images in. Default is `assets`.\n\n`size`: The size to resize the images to, specified as [width, height]. Default is `[800, 600]`.\n\n`extensions`: List of image file extensions to consider for resizing. The plugin will look for images with these extensions in both lower and upper case. Default is `['.jpg', '.jpeg', '.png', '.gif', '.svg']`.\n\n`enable_cache`: Whether to enable caching. If enabled, the plugin will check if a file has changed since the last time the plugin ran, and if not, it won't process the file again. Default is `True`.\n\n`debug`: Option to enable debug output. Default is `False`.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjakubandrysek%2Fmkdocs-resize-images","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjakubandrysek%2Fmkdocs-resize-images","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjakubandrysek%2Fmkdocs-resize-images/lists"}