Modify which files MkDocs includes or excludes.
Project description
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.
Project details
Release history Release notifications | RSS feed
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_include_exclude_files-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5bdf064604884b50402ab180c22d3eeb6088c5eebae6507e0b848edb6ded5581 |
|
MD5 | 91e7ef8f1b637736edf4a08c6894c5ff |
|
BLAKE2b-256 | 67a0ede3bcdca75bddda1723a7d3629af275e8d412a52dd43aa8463445d698d4 |
Close
Hashes for mkdocs_include_exclude_files-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3fce8a6da46cdc1337c344b401cca0ef2234f91cae1f804abd7b4c43a5598d85 |
|
MD5 | f4f6dddf413b5deea4ce67e81861ee16 |
|
BLAKE2b-256 | 65a56238b61878729a0e8c78ee2daefaddc57bb5356dc525f37f39749fad9c84 |