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.
Release files for mkdocs-include-exclude-files 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs_include_exclude_files-0.1.0.tar.gz | 6.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_include_exclude_files-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 13.7 kB
Release files / mkdocs_include_exclude_files-0.1.0.tar.gz
| Download URL | mkdocs_include_exclude_files-0.1.0.tar.gz |
|---|---|
| Size | 6.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
12070405b70ac4c142b25054423be191b6dc183c0a4699889d147ba18b655864
|
|
BLAKE2b-256 checksum How to use checksums |
d3245fce6ec44bf80421f5106494da0e8f9de9ec7cd68eed8058989cab341774
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.0
|
Release files / mkdocs_include_exclude_files-0.1.0-py3-none-any.whl
| Download URL | mkdocs_include_exclude_files-0.1.0-py3-none-any.whl |
|---|---|
| Size | 6.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b1d49d8127a8eb1a061b4482174380566b6075d98e028404ef00a912dcabf00b
|
|
BLAKE2b-256 checksum How to use checksums |
4797c40c82bc7843715f55d4a0c2e9b02fbe8197a1c64703b7633c759fe8395d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.0
|