mkdocs-exclude-search 0.2.0

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

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.
• Exclude all markdown files within a specific directory with directory_name/*.md.
• 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
        - some_directory/*.md
      ignore:
        - second.md#another-heading

nav:
    - Home: index.md
    - First chapter: first.md
    - Second chapter: second.md
    - Third chapter: third.md
    - Fourth chapter: some_directory/fourth.md

This example would exclude:

• the second chapter (but still include its another-heading subsection)
• the some-heading subsection of the third chapter.
• all markdown files within some_directory.

See Also

More information about templates here.

More information about blocks here.