mkdocs-excluder-plugin

File exclude plugin for mkdocs

Extension of mkdocs-exclude plugin to also provide navigation filtering.

mkdocs-excluder-plugin is a mkdocs plugin that allows you to exclude files from your input using unix-style wildcards (globs) or regular expressions (regexes).

This implements what people were asking for in some mkdocs bugs, such as https://github.com/mkdocs/mkdocs/issues/1500 and https://github.com/mkdocs/mkdocs/issues/1152.

Quick start

• Install the module using pip: pip install mkdocs-excluder-plugin

• In your project, add a plugin configuration to mkdocs.yml:

  plugins:
    - excluder:
        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 glob: and regex: lines must not start with a dash, but the lines under them must start with a dash.

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.