Vuepress2-plugin-full-text-search NPM

vuepress2-plugin-full-text-search

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 vuepress2-plugin-full-text-search

e.g. .vuepress/config.js

import fullTextSearchPlugin from "vuepress2-plugin-full-text-search";
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 "vuepress2-plugin-full-text-search";
export default {
  plugins: [
    fullTextSearchPlugin({
      locales: {
        '/': {
          placeholder: 'Search',
        },
        '/zh/': {
          placeholder: '搜索',
        },
      },
    }),
  ],
}