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 in other pages.
Instalation
Run pip install --upgrade mkdocs-exclude-unused-files
Configuration
Basic Configuration in the mkdocs.yml
file:
plugins:
- mkdocs_exclude_unused_files:
file_types_to_check: ["png", "jpg", "jpeg", "gif"]
This configuration will exclude all files from the final mkdocs output that have one of the configured file endings and are not referenced / linked to in other pages.
All Configuration Options
Setting | Default | Description |
---|---|---|
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 | ["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"] | Only check these file types for their usage and delete them if necessary. |
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. |
Project details
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
Close
Hashes for mkdocs-exclude-unused-files-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c1e83ccbf6ba2e29f6be0180a12417856d1542cfa1c44e609adfe2e2412b259f |
|
MD5 | cad5b30eb85e643f37fafe1a896ffef0 |
|
BLAKE2b-256 | 4c98fd46a8592777485d3af67eb1474b47cb033c0aaa4181959fc5caa3af1cc8 |
Close
Hashes for mkdocs_exclude_unused_files-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9388c7f31dd2b4966658648eff33f9618bda8aa6b05f4004f3689f72ea352062 |
|
MD5 | 2187d39976803f97cbfa4ec6ce076e62 |
|
BLAKE2b-256 | 68b6dacf2b34673226d306e02aa271ec6146c1875a0eff979abe02be8ae43f3d |