{"categories":[{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation"}],"enrichment":{"capability":"A mkdocs plugin that excludes files and directories from documentation builds using glob patterns or regular expressions.","skillfed_tags":["mkdocs-plugin","abandoned"],"use_cases":["Exclude temporary or draft files (*.tmp, *.draft) from being processed during mkdocs builds","Filter out compiled artifacts or build outputs (*.pdf, *.gz, *.bin) from documentation source trees","Skip entire directories of reference material or work-in-progress content from the final documentation","Use regex patterns to exclude files matching complex naming conventions or extensions"],"what_it_does":"mkdocs-exclude is a plugin for mkdocs that filters out files and directories during the documentation build process. You configure it in mkdocs.yml with glob patterns (like `*.tmp`, `exclude/this/path/*`) or regular expressions to match files you want to skip. It solves the problem of having source files in your documentation tree that you don't want included in the final build\u2014temporary files, compiled artifacts, or directories meant for reference only.\n\nThe plugin has no runtime dependencies and integrates directly into mkdocs' build pipeline. Configuration is straightforward: you list your exclusion patterns under `glob:` and `regex:` keys in the plugin section of mkdocs.yml. However, the project is no longer maintained, with the last release in February 2019 and no activity since early 2023, so compatibility with recent mkdocs versions is uncertain.","worth_installing":"No\u2014unless you are maintaining an existing mkdocs site already using this plugin. The package is abandoned with no releases since 2019 and no maintenance since early 2023. Modern mkdocs may have built-in or better-maintained alternatives for file exclusion. If you need this functionality, check whether mkdocs itself or a more actively maintained plugin provides it."},"id":"mkdocs-exclude","links":{"html":"https://skillfed.io/packages/mkdocs-exclude","md":"https://skillfed.io/packages/mkdocs-exclude.md","pypi":"https://pypi.org/project/mkdocs-exclude/"},"maintenance":{"status":"abandoned"},"meta":{"latest_release":"2019-02-20","license_spdx":null,"license_treatment":"permissive","name":"mkdocs-exclude","python_support":"unspecified","summary":"A mkdocs plugin that lets you exclude files or trees."},"popularity":{"monthly_downloads":253989,"position":8506,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"1.0.2"}