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 thesearch
plugin. MkDocs enables it by default if there is noplugins
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
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.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7fa938e9dedc197aab30063e3b339120a718fc366c25776d3ac1d3dc096ae2d |
|
MD5 | 11f02d4db4ca17d95e431f977154b991 |
|
BLAKE2b-256 | dda5ce6f2940d52b82fde0906e7aa30657e87cd7c7492ca70b4b56e4e28ddc9c |
Hashes for mkdocs_exclude_search-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d8db69ac4b126b1bfcd954a5211112f9c21ab37bd1bae3c88d876c6692484275 |
|
MD5 | b324a7e09b9e389c395c92240fe872bf |
|
BLAKE2b-256 | 96cfe4c19e26632cdde29397f41057b0636856555249c4039426d2e03c00fa8e |