Registry / devops / mkdocs-exclude-search

mkdocs-exclude-search

library0.6.6pypypiunverified

A MkDocs plugin that allows excluding selected files or sections from the search index. Current version 0.6.6, stable maintenance mode.

devops search

pip install mkdocs-exclude-search

github ↗homepage ↗

INSTALL

IMPORT

SIG · MKDOCS-EXCLUDE-SEA

mkdocs-exclude-search

devopspythonv0.6.6

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Add plugin to mkdocs.yml. The 'search' plugin must be listed before 'exclude-search'. Example excludes specific files and directories.

# mkdocs.yml plugins: - search - exclude-search: exclude: - hidden-file.md - secret-dir/* ignore: [] # optional, list of files to re-include case_insensitive: false

Debug

Known issues

breakingThe 'search' plugin must be listed before 'exclude-search' in the plugins list. Otherwise the exclude logic may not apply correctly.

fix

Ensure 'search' appears before 'exclude-search' in mkdocs.yml plugins section.

affects: all

deprecatedPlugin is in maintenance mode; no new features planned. Be aware for future compatibility.

fix

Consider alternatives if active development is needed.

affects: 0.6.6

gotchaExclude patterns use glob matching (e.g., 'secret-dir/*'), not regex. Relative paths are from the docs directory.

fix

Review MkDocs glob patterns documentation for exact syntax.

affects: all

Errors

Common errors & fixes

ERROR - Config value: 'plugins'. Error: The "exclude-search" plugin is not installed

Plugin not installed via pip, or virtual environment not activated.

fix

Run 'pip install mkdocs-exclude-search' and ensure you are using the correct Python environment.

WARNING - Plugin 'exclude-search' has no effect because 'search' plugin is missing or not enabled

The 'search' plugin is not listed before 'exclude-search' in mkdocs.yml.

fix

Add 'search' plugin before 'exclude-search': plugins: [search, exclude-search: ...]

Upgrade

Version history

0.6.6latest on PyPI · released Dec 3, 2023

Audit

Dependencies

mkdocsrequiredPlugin for MkDocs, requires MkDocs to be installed.

Agent activity

18 hits · last 30 days

node

Resources

githubhttps://github.com/chrieke/mkdocs-exclude-search ↗

homepagehttps://github.com/chrieke/mkdocs-exclude-search ↗