A mkdocs plugin that excludes assets that are unused (orphaned) from being included in the final mkdocs output.
Project description
MkDocs Exclude Unused (orphaned) Files
A simple plugin for excluding files from being included in the mkdocs output if they are not referenced on other pages.
Installation
Run pip install --upgrade mkdocs-exclude-unused-files
Configuration
Basic Configuration in the mkdocs.yml file:
plugins:
- exclude-unused-files:
file_types_to_check: ["png", "jpg", "jpeg", "gif"]
enabled: !ENV [CI, false]
This configuration will exclude all files from the final mkdocs output that has one of the configured file endings and are not referenced/linked to other pages.
Default types
The plugin uses a default set of file types:
png, jpg, jpeg, gif, pdf, ico, drawio, tif, tiff, zip, tar.gz, rar, ogg, mp3, mp4, vtt , ogv, mov, svg, pot, potx, ppsx, ppt, pptx, xlt, xltx, xls, xlsx, doc, docx, dot, dotx, vst, vstx, vsd, vsdx
All Configuration Options
| Setting | Default | Description |
|---|---|---|
| enabled | True |
Whether the plugin is enabled when building your project. If you want to switch the plugin off, e.g. for local builds, use an environment variables. |
| enabled_on_serve | False |
Whether the plugin is enabled when serving your project. It does not apply if enabled is False. It's just to explicitly enable the plugin during mkdocs serve. |
| dry_run | False |
Only print output into the command line and don't actually delete anything |
| silent | False |
Don't print out the found orphan files in the build process |
| force_delete | False |
By default the plugin only deletes files that are actually in the configured mkdocs output directory (site_dir). If you want to delete these files anyways due to your setup, enable this flag |
| file_types_to_check | [] |
Only check these file types for their usage and delete them if necessary. |
| file_types_override_mode | replace |
Behavior of file_types_to_check towards default types: replace - uses only defined types, append - adds additional types to default list, remove - removes specified types from default. |
| file_names_to_never_remove | ["favicon"] |
Files with these names will never get deleted, even if no usage is detected. |
| folders_to_never_remove_from | ["assets"] |
Files in these folders will never get deleted, even if no usage is detected. Useful for always including specific static files. |
| file_name_suffixes_to_trim | ["#only-light", "#only-dark"] |
Trim-away suffixes in this list when checking if a file-name is used. This is used for ignoring material-mkdoc's color-palette-toggle instructions (see Issue-4). |
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocs_exclude_unused_files-1.3.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f6eda2278f7b0059f4f63e0d9587334e106ab6861cf7b2879a1a1af7ae31e752 |
|
| MD5 | e76d08f8de4eeacb4a3c158e60a7159d |
|
| BLAKE2b-256 | bf98052badf202f0b3966ae259c8c30891a4462a27fb0c72e5fcca9f6597249f |
Hashes for mkdocs_exclude_unused_files-1.3.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0d4982bf79f9b2dc00e6a5314343d7a863982f2ea014a0fef6fbc79f1f621662 |
|
| MD5 | 7e8d3156826fc6103d394ec1649f4b95 |
|
| BLAKE2b-256 | 3c4c6cc5f1c83c6484d1bd6e6bc9fbc40707eb7bba644eb3ce8bb71ecab38c32 |
