vuepress-plugin-full-text-search2

VuePress v2 plugin that adds full-text search box.
1,821 38
Install
npm install vuepress-plugin-full-text-search2
Latest Version:0.5.1
Vue:3
License:MIT
Last Updated:Oct 20, 2026
Links: GitHub  ·  npm
Maintainer: ota-meshi

vuepress-plugin-full-text-search2

VuePress v2 plugin that adds full-text search box.

screenshot

:warning: WARNING: this project is considered to be in BETA until VuePress v2 is available for general use and the API is stable!

Usage

npm i -D vuepress-plugin-full-text-search2

e.g. .vuepress/config.js

import fullTextSearchPlugin from "vuepress-plugin-full-text-search2";
module.exports = {
  plugins: [fullTextSearchPlugin],
};

Options

locales

  • Type: Record<string, { placeholder: string }>

  • Details:

    The text of the search box in different locales.

    If this option is not specified, it will fallback to default text.

  • Example:

import fullTextSearchPlugin from "vuepress-plugin-full-text-search2";
export default {
  plugins: [
    fullTextSearchPlugin({
      locales: {
        '/': {
          placeholder: 'Search',
        },
        '/zh/': {
          placeholder: '搜索',
        },
      },
    }),
  ],
}

Related Packages

vuepress-plugin-code-enhance

A plugin for adding full-screen and copy button to your code blocks in VuePress...

584 370
@vuepress/plugin-theme-data

VuePress plugin - theme data

1,355,751 2,833
@vuepress/plugin-external-link-icon

VuePress plugin - external link icon

308,812 2,833
@vuepress/plugin-redirect

VuePress plugin - redirect

178,337 62
@vuepress/plugin-copyright

VuePress plugin - copyright

169,707 62

Version History

Version Released Vue License
0.5.1 ^3.2.0 MIT
0.4.0 ^3.2.0 MIT
0.3.0 ^3.2.0 MIT