A mkdocs plugin that lets you exclude files or trees.
File exclude plugin for mkdocs
mkdocs-exclude is a
mkdocs plugin that allows you
to exclude files from your input using unix-style wildcards (globs) or
regular expressions (regexes).
Install the module using pip:
pip3 install mkdocs-exclude
In your project, add a plugin configuration to
plugins: - exclude: glob: - exclude/this/path/* - "*.tmp" - "*.pdf" - "*.gz" regex: - '.*\.(tmp|bin|tar)$'
You can provide zero or more patterns of each type. (If you don't provide any patterns, then nothing will happen!)
Note! Because of peculiarity of yaml syntax, the
must not start with a dash, but the lines under them must start with
Also because of yaml, patterns that start with a punctuation mark must be quoted.
When writing regexes, it's best to use single quotes rather than double quotes, so that your regex backslash escapes are preserved correctly without having to be doubled up.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size mkdocs-exclude-1.0.2.tar.gz (6.8 kB)||File type Source||Python version None||Upload date||Hashes View|