Modify which files MkDocs includes or excludes.
Project Links
Meta
Author: Patrick Kidger
Maintainer: Patrick Kidger
Requires Python: ~=3.8
Classifiers
Development Status
- 3 - Alpha
Intended Audience
- Developers
License
- OSI Approved :: Apache Software License
Natural Language
- English
Programming Language
- Python :: 3
mkdocs_include_exclude_files
By default, mkdocs copies everything it can find in the docs_dir
directory that doesn't start with a .
This plugin allows for customising that.
Installation
pip install mkdocs_include_exclude_files
Requires MkDocs 1.2.3+ and Python 3.8+
Usage
In mkdocs.yml
:
plugins:
- search # default plugin, need to re-enable when using manual plugins
- include_exclude_files:
- include:
- ".some_file"
- ".anotherfile"
- exclude
- "some_folder"
- "anotherfolder"
Every file exactly matching those in include
will be included. Any file whose location starts with anything in exclude
will be excluded.
Wheel compatibility matrix
Files in release
Extras:
None
Dependencies:
(>=1.2.3)
mkdocs