# ZipFolders MkDocs Plugin
The `ZipFolders` plugin is used to zip specified folders in your MkDocs project after the site build process. This can be helpful if you need to distribute or backup parts of your documentation.
## Installation
Install the plugin using pip from [PyPI](https://pypi.org/project/mkdocs-zip-folders/):
```bash
pip install mkdocs-zip-folders
```
## Configuration
To use the `ZipFolders` plugin, you need to add it to your `mkdocs.yml` configuration file.
Here is a sample configuration:
```yaml
plugins:
- search
- zip_folders:
folders:
- myCode
- toShare
- folderX/thisWillBeZipped
hash_extension: ".zip.hash" # default extension
debug: true # optional - default is false
```
- `folders` - A list of folders to zip. The folders are relative to the root of the MkDocs documentation project - docs_dir (default is `docs`).
- `debug` - Optional. If set to `true`, the plugin will print debug messages to the console. Default is `false`.
- `hash_extension` - The extension to use for hashing folders. Default is `.zip.hash`.
## Git configuration
It is highly recommended to add the `*.zip`, `*.zip.hash` filses to your `.gitignore` file. This will prevent you from accidentally committing the zip files to your repository.
Zip files will be generated automatically after each build.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## Do You Enjoy My Work?
Then definitely consider:
- supporting me on GitHub Sponsors: [](https://github.com/sponsors/jakubandrysek)
## License
[MIT](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": "https://github.com/JakubAndrysek/mkdocs-zip-folders",
"name": "mkdocs-zip-folders",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "mkdocs plugin zip folders download zip-folders",
"author": "Jakub Andr\u00fdsek",
"author_email": "email@kubaandrysek.cz",
"download_url": "https://files.pythonhosted.org/packages/95/53/e9deff52dc3a5a07b48fcda2361913be2ed5d09e1325cc2e22d90adb1919/mkdocs-zip-folders-1.0.3.tar.gz",
"platform": null,
"description": "# ZipFolders MkDocs Plugin\n\nThe `ZipFolders` plugin is used to zip specified folders in your MkDocs project after the site build process. This can be helpful if you need to distribute or backup parts of your documentation.\n\n\n\n## Installation\n\nInstall the plugin using pip from [PyPI](https://pypi.org/project/mkdocs-zip-folders/):\n\n```bash\npip install mkdocs-zip-folders\n```\n\n## Configuration\n\nTo use the `ZipFolders` plugin, you need to add it to your `mkdocs.yml` configuration file.\n\nHere is a sample configuration:\n\n```yaml\nplugins:\n - search\n - zip_folders:\n folders:\n - myCode\n - toShare\n - folderX/thisWillBeZipped\n hash_extension: \".zip.hash\" # default extension\n debug: true # optional - default is false\n```\n\n- `folders` - A list of folders to zip. The folders are relative to the root of the MkDocs documentation project - docs_dir (default is `docs`).\n- `debug` - Optional. If set to `true`, the plugin will print debug messages to the console. Default is `false`.\n- `hash_extension` - The extension to use for hashing folders. Default is `.zip.hash`.\n\n\n## Git configuration\n\nIt is highly recommended to add the `*.zip`, `*.zip.hash` filses to your `.gitignore` file. This will prevent you from accidentally committing the zip files to your repository.\n\nZip files will be generated automatically after each build.\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n## Do You Enjoy My Work?\nThen definitely consider:\n\n- supporting me on GitHub Sponsors: [](https://github.com/sponsors/jakubandrysek)\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MkDocs plugin to zip configured folders and add them to the site.",
"version": "1.0.3",
"project_urls": {
"Documentation": "https://zip-folders.kubaandrysek.cz/",
"Funding": "https://github.com/sponsors/jakubandrysek",
"Homepage": "https://github.com/JakubAndrysek/mkdocs-zip-folders",
"Source": "https://github.com/JakubAndrysek/mkdocs-zip-folders",
"Tracker": "https://github.com/JakubAndrysek/mkdocs-zip-folders/issues"
},
"split_keywords": [
"mkdocs",
"plugin",
"zip",
"folders",
"download",
"zip-folders"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "396cb4608e11f7070de3d0acfad1a5b181fff34d6b284cd6cea007f5f7c2c152",
"md5": "3742e9de265427633424684281391094",
"sha256": "aa4d4d052ec6146a11874b402cd7f949523d8ccf6bdff227da58aaeea2e41e49"
},
"downloads": -1,
"filename": "mkdocs_zip_folders-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3742e9de265427633424684281391094",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4873,
"upload_time": "2023-07-09T13:34:08",
"upload_time_iso_8601": "2023-07-09T13:34:08.701955Z",
"url": "https://files.pythonhosted.org/packages/39/6c/b4608e11f7070de3d0acfad1a5b181fff34d6b284cd6cea007f5f7c2c152/mkdocs_zip_folders-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9553e9deff52dc3a5a07b48fcda2361913be2ed5d09e1325cc2e22d90adb1919",
"md5": "9a234cb5fa5b6de756f204d97afcbd5a",
"sha256": "bc794d58e39c303f6c68bf1e908d3ce5ea99638795bdf7625dcb7c8d80452bd8"
},
"downloads": -1,
"filename": "mkdocs-zip-folders-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "9a234cb5fa5b6de756f204d97afcbd5a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4354,
"upload_time": "2023-07-09T13:34:10",
"upload_time_iso_8601": "2023-07-09T13:34:10.078233Z",
"url": "https://files.pythonhosted.org/packages/95/53/e9deff52dc3a5a07b48fcda2361913be2ed5d09e1325cc2e22d90adb1919/mkdocs-zip-folders-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-09 13:34:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JakubAndrysek",
"github_project": "mkdocs-zip-folders",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "mkdocs",
"specs": []
}
],
"lcname": "mkdocs-zip-folders"
}
JSON
