vuepress-plugin-full-text-search2
TypeScript icon, indicating that this package has built-in type declarations

0.5.1 • Public • Published

vuepress-plugin-full-text-search2

VuePress v2 plugin that adds full-text search box.

screenshot

⚠️ 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: '搜索',
        },
      },
    }),
  ],
}

Package Sidebar

Install

npm i vuepress-plugin-full-text-search2

Weekly Downloads

71

Version

0.5.1

License

MIT

Unpacked Size

40 kB

Total Files

21

Last publish

Collaborators

  • ota-meshi