Skip to main content

mkdocs-exclude-search

A mkdocs plugin that excludes selected chapters from the docs search index.

If you only need to exclude a few pages or sections, mkdocs-material now introduced built-in search exclusion! The mkdocs-exclude-search plugin complements this with more configuration options (wildcard exclusions, ignoring excluded subsections). It also provides search-exclusion functionality to regular mkdocs users.

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.

Works with both the default use_directory_urls: true and use_directory_urls: false. The site index page (index.md) is always kept in the search index.

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.

Metadata

Release files for mkdocs-exclude-search 0.6.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-exclude-search 0.6.7
File Size Uploaded Provenance Actions
mkdocs_exclude_search-0.6.7.tar.gz 11.2 kB Without provenance Details for mkdocs_exclude_search-0.6.7.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-exclude-search 0.6.7
File Interpreter ABI Platform Actions
mkdocs_exclude_search-0.6.7-py3-none-any.whl Python 3 none any Details for mkdocs_exclude_search-0.6.7-py3-none-any.whl

Total release size: 19.6 kB

Release files / mkdocs_exclude_search-0.6.7.tar.gz

Download URL mkdocs_exclude_search-0.6.7.tar.gz
Size 11.2 kB
Tags Source
SHA-256 checksum
How to use checksums
54a79d6fb2de39f8569ed3cb0924e5abe6c02b256192b84479db6ed377a195f3
BLAKE2b-256 checksum
How to use checksums
cb1ac0c1318768f546ed5b8de45956719d698057241f406f787c5b9ceebc1af2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.0

Release files / mkdocs_exclude_search-0.6.7-py3-none-any.whl

Download URL mkdocs_exclude_search-0.6.7-py3-none-any.whl
Size 8.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2f699c92a034329f2de4a0fea8f821a50b61dd2d370d65118a7545db8787e490
BLAKE2b-256 checksum
How to use checksums
b5c8e4db4566f6e8550a337cebd2f4dce9684800fc74bf47b7d44c8417138083
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.0

Security for mkdocs-exclude-search 0.6.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page