mkdocs-exclude
A mkdocs plugin that lets you exclude files or trees.
Decision gist · record as of 2026-08-14
No—unless 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.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires mkdocs to be installed and configured; compatibility with current mkdocs versions is uncertain given the package's abandonment since 2019.
- High install friction with no runtime dependencies.
- The package is abandoned—last release was 2019-02-20 and last commit 2023-02-02—so expect no maintenance or bug fixes going forward.
License · maintenance · safety
Apache (permissive) — Licensed under Apache (permissive), so you can use it freely in commercial or open-source projects without copyleft obligations.
last release 2019-02-20 (2732 days) · last repo commit 2023-02-02 · 95 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 253,989 downloads/mo, #8,506 on PyPI
Alternatives
Verify before relying
pip install mkdocs-exclude
Then add to mkdocs.yml:
plugins:
- exclude:
glob:
- exclude/this/path/*
- "*.tmp"
regex:
- '.*\.(tmp|bin)$'- Whether the plugin works with current mkdocs versions (no releases since early 2019)
- Python version compatibility (requires_python field is empty in metadata)
What it is and 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—temporary files, compiled artifacts, or directories meant for reference only.
The 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.
Use it for
- 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
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
No—unless 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.
Install
mkdocs-exclude on PyPI
Before you install
High install friction with no runtime dependencies. The package is abandoned—last release was 2019-02-20 and last commit 2023-02-02—so expect no maintenance or bug fixes going forward.
Requires mkdocs to be installed and configured; compatibility with current mkdocs versions is uncertain given the package's abandonment since 2019.
License in practice
Licensed under Apache (permissive), so you can use it freely in commercial or open-source projects without copyleft obligations.
Quickstart
pip install mkdocs-exclude
Then add to mkdocs.yml:
plugins:
- exclude:
glob:
- exclude/this/path/*
- "*.tmp"
regex:
- '.*\.(tmp|bin)$'Verify before relying
- Whether the plugin works with current mkdocs versions (no releases since early 2019)
- Python version compatibility (requires_python field is empty in metadata)
Package facts
| License | Apache permissive |
| Python support | Not specified |
| Install friction | High. Source build required |
| Runtime dependencies | None |
| Maintenance | Abandoned 2,732 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 253,989 / month, #8,506 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
Evidence: mkdocs-exclude-1.0.2.tar.gz
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “mkdocs file exclusion”
- mkdocs-excludeA mkdocs plugin that excludes files and directories from…
- mkdocs-literate-navMkDocs plugin that lets you define site navigation as Markdown lists…
- mkdocs-auto-tag-pluginAutomatically assigns tags to MkDocs pages based on their file path,…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also condor-git-config · mkdocs-auto-tag-plugin · mkdocs-include-markdown-plugin · mkdocs-awesome-pages-plugin · formic2 · mkdocs-awesome-nav · mkdocs-htmlproofer-plugin · mkdocs-simple-hooks · mkdocs-include-dir-to-nav · filecheck