Mkdocs Exclude

Overview

The mkdocs-exclude plugin is a powerful tool that enhances your mkdocs experience by allowing users to easily exclude files from their documentation input. With the ability to leverage unix-style wildcards or regular expressions, this plugin addresses user requests for more control over which files are processed, responding to common concerns noted in mkdocs' bug reports.

This plugin is particularly useful for developers looking to streamline their documentation processes. By excluding unnecessary files, it helps in maintaining a clean and organized documentation structure, making it easier to focus on the important content.

Features

• File Exclusion: Easily exclude specific files or folders from your mkdocs build using simple patterns or complex expressions.
• Flexible Patterns: Supports both unix-style wildcards and regular expressions for maximum customization in file selection.
• Simple Installation: Quick to install via pip with just one command, making it accessible for all users.
• Custom Configuration: Integrate seamlessly into your mkdocs project with a straightforward configuration in the mkdocs.yml file.
• YAML Compatibility: Designed with YAML syntax considerations, ensuring users avoid common pitfalls like incorrect formatting.
• Regex Support: Allows for advanced filtering with regular expressions, giving developers added flexibility in how files are included or excluded.
• User-Friendly: Easy setup and clear documentation make it approachable for users of all levels, eliminating confusion during implementation.