Skip to main content

A mkdocs plugin that lets you exclude selected files or sections from the search index.

Project description

mkdocs-exclude-search

A mkdocs plugin that lets you exclude selected files or sections from the search index.

PyPI - Downloads

Setup

Install the plugin using pip:

pip install mkdocs-exclude-search

Activate the search and exclude-search plugins in mkdocs.yml. search is required, otherwise exclude-search has no effect!

plugins:
  - search
  - exclude-search

More information about plugins in the MkDocs documentation.

Configuration

  • List the markdown files to be excluded under exclude using the format <path>/<to>/filename.md in the docs folder.
  • Exclude specific heading subsections using the format <path>/<to>/filename.md#some-heading. Chapter names are all lowercase, - as separator, no spaces.
  • Exclude all markdown files within a directory (and its children) with dirname/*.
  • Exclude all markdown files with a specific name within all subdirectories with dirname/*/filename.md or /*/filename.md.
  • To still include a subsection of an excluded file, list the subsection heading under ignore using the format <path>/<to>/filename.md#some-heading.
  • To exclude all unreferenced files (markdown files not listed in mkdocs.yml nav section), use exclude-unreferenced: true. Default false.
plugins:
  - search
  - exclude-search:
      exclude:
        - first.md
        - dir/second.md
        - third.md#some-heading
        - dir2/*
        - /*/fifth.md
      ignore:
        - dir/second.md#some-heading
      exclude-unreferenced: true
nav:
    - Home: index.md
    - First chapter: first.md
    - Second chapter: dir/second.md
    - Third chapter: third.md
    - Fourth chapter: dir2/fourth.md
    - Fifth chapter: subdir/fifth.md

This example would exclude:

  • the first chapter.
  • the second chapter (but still include its some-heading section).
  • the some-heading section of the third chapter.
  • all markdown files within dir2 (and its children directories).
  • all markdown files named fifth.md within all subdirectories.
  • all unreferenced files

See Also

More information about templates here.

More information about blocks here.

Project details


Download files

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

Source Distribution

mkdocs-exclude-search-0.6.4.tar.gz (6.6 kB view hashes)

Uploaded source

Built Distribution

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