Skip to main content

A mkdocs plugin that lets you exclude files or trees.

Project description

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).

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

  1. Install the module using pip: pip3 install mkdocs-exclude

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

    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 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mkdocs-exclude, version 1.0.2
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

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page