Search Plugin

MkDocs comes with a built-in and automatically enabled search plugin.

Built-in Support

Terminal for MkDocs supports the built-in search plugin by providing a search button in the top navigation menu and a search modal to display search results:

Built-in Search Plugin Support

Configuration

The search button in the top navigation bar can be hidden by adding navigation.top.search_button.hide to your theme feature configuration in mkdocs.yml:

theme:
  name: terminal
  features:
    - navigation.top.search_button.hide

Note

If you wish to use additional plugins besides the default search plugin you will need to re-add search to your plugins list in mkdocs.yml:

plugins:
  - search
  - some_other_plugin