Search Plugin Config

Intro

The theme adds built-in support for the following three plugins:

• @vuepress/plugin-docsearch
• vuepress-plugin-search-pro
• @vuepress/plugin-search

Only 1 of the 3 can be enabled at the same time, and the priority is docsearch > searchPro > search.

plugins.docsearch

Options which will be passed to @vuepress/plugin-docsearch, for details, see DocSearch plugin documentation.

Note

You need to install @vuepress/plugin-docsearch manually.

plugins.searchPro

You can set it to true to enable it directly, or an object to configure will be passed to vuepress-plugin-search-pro.

For details, see search-pro documentation.

Note

You need to install vuepress-plugin-search-pro manually.

plugins.search

You can set it to true to enable it directly, or an object to configure will be passed to @vuepress/plugin-search.

For details, see search plugin documentation.

Note

You need to install @vuepress/plugin-search manually.