A mkdocs plugin that lets you conditionally include files or trees.
Project description
File exclude plugin for mkdocs
mkdocs-exclude
is a mkdocs plugin that allows you
to conditionally include files from your input using regular expressions (regexes).
This will only include the following files in your mkdocs
:
- file location does not have the specified prefix
- file is in the specified prefix, and matches any of the specified regexes
The big advantage of this is, that you can include your closed-source repositories into a mkdocs monorepo, and explicitly ONLY include your documentation sub-folders in the mkdocs
artifacts.
Quick start
- Install the module using pip:
pip3 install mkdocs-conditional-include
- In your project, add a plugin configuration to
mkdocs.yml
:
plugins:
- conditional_include:
rules:
- prefix: my-docs
regex:
- '.*\/docs\/.*'
- '.*\/docs-assets\/.*'
- prefix: my-docs-2
regex:
- '.*\/docs\/.*'
Not specifying any prefix will run the particular rule over all files, thus filtering everything.
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-conditional-include-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 162b1c87b9cde91859c3ff3a4ac5f1256f2ff59b642a691d782ce7689dc0bc23 |
|
MD5 | 4218ef5b1fb93b6e091b29f34e625675 |
|
BLAKE2b-256 | 6aaa221bac485dc8d0fbd4c34b1de92e1df9986cd8d858bce66128a446dd5e5a |
Close
Hashes for mkdocs_conditional_include-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c381af9b0e84d6b5f0508b7b686693c60205be0411d2a2dac4634c9a7e05451e |
|
MD5 | 461b41d3470e4b6050bd630576edc0c0 |
|
BLAKE2b-256 | 5421565e877dee8de518ced39f3e35447b075292ebb2bd4a8998ae88d9beb1f3 |