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.
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.
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocs-exclude-search-0.6.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6a126367653caf946c56e446ff30ffdec931438a3e2a8740feff3f8682d52a54 |
|
MD5 | c4f96867c09fe14bd0cba2c069fb8219 |
|
BLAKE2b-256 | b3aae5c69fa5161e5df38e6f5cfe779a7db350b8e7e5369ccf799dc7a4eb5253 |
Hashes for mkdocs_exclude_search-0.6.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 475e372dd17195700acd00213bcc804280d63f39cb7a0c76a801aceefd2807a6 |
|
MD5 | 75d1d53902b9c09829d73cba47d8dd36 |
|
BLAKE2b-256 | 23a46d0859c0d7bf4bc5d815aa216102c983f795ea6a9d55689130d8641ed6b9 |