ZipFolders MkDocs Plugin
The ZipFolders plugin is used to create archives (zip and tar.gz) of 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:
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:
plugins:
- search
- zip_folders:
folders:
- myCode
- toShare
- folderX/thisWillBeZipped
formats:
- zip
- tar.gz
hash_extension: ".hash" # default extension
debug: true # optional - default is false
folders- A list of folders to archive. The folders are relative to the root of the MkDocs documentation project - docs_dir (default isdocs).formats- A list of archive formats to create. Supported formats arezipandtar.gz. Default is['zip'].debug- Optional. If set totrue, the plugin will print debug messages to the console. Default isfalse.hash_extension- The extension to use for hashing archives. Default is.hash.
Git configuration
It is highly recommended to add the archive files and hash files to your .gitignore file. This will prevent you from accidentally committing the archive files to your repository.
# Archive files generated by mkdocs-zip-folders
*.zip
*.tar.gz
*.zip.hash
*.tar.gz.hash
Archive 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:
License
Metadata
Release files for mkdocs-zip-folders 1.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs_zip_folders-1.0.5.tar.gz | 4.9 kB | Without provenance | Details for mkdocs_zip_folders-1.0.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_zip_folders-1.0.5-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_zip_folders-1.0.5-py3-none-any.whl |
Total release size: 10.4 kB
Release files / mkdocs_zip_folders-1.0.5.tar.gz
| Download URL | mkdocs_zip_folders-1.0.5.tar.gz |
|---|---|
| Size | 4.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
feb6c80a90ee5cbc3db4f4ff69e8fc62d9437477f5918c15b6fcb672da4156dd
|
|
BLAKE2b-256 checksum How to use checksums |
1ee536a868778f7792abc9ea7e48566f38652864f07aaa8e4fe7b79b1283dc90
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.5
|
Release files / mkdocs_zip_folders-1.0.5-py3-none-any.whl
| Download URL | mkdocs_zip_folders-1.0.5-py3-none-any.whl |
|---|---|
| Size | 5.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f4a3dc7ece1aac7aad854553d1e4b981ebc67bbf8bbb7f9fcd3c7846ade7874f
|
|
BLAKE2b-256 checksum How to use checksums |
bdcf4fa4802e7fa8d560f64f19d9d650ce37913480e9240747fb679e751569d3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.5
|
Security for mkdocs-zip-folders 1.0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.