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.

Setup

Install the plugin using pip:

pip install mkdocs-exclude-search

Activate the plugin in mkdocs.yml:

plugins:
  - search
  - exclude-search

Note: If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set, but now you have to enable it explicitly.

More information about plugins in the MkDocs documentation.

Config

List the markdown files to be excluded under exclude using the format filename.md. Exclude specific heading subsections using the format filename.md#some-heading.

To only include a specific heading subsection of an excluded file, list the subsection under ignore.

plugins:
  - search
  - exclude-search:
      exclude:
        - second.md
        - third.md#some-heading
      ignore:
        - second.md#another-heading
nav:
    - Home: index.md
    - First chapter: first.md
    - Second chapter: second.md
    - Third chapter: third.md

This example would exclude from the search the second chapter and the some-heading header subsection of the third chapter.

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.

Files for mkdocs-exclude-search, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size mkdocs_exclude_search-0.1.1-py3-none-any.whl (4.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size mkdocs-exclude-search-0.1.1.tar.gz (3.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page