emersonbottero / vitepress-plugin-search

Provide local search to your documentation site.
MIT License
238 stars 30 forks source link

Provides local search to your documentation site

Uses flexsearch.

Installing

npm i vitepress-plugin-search flexsearch -D

Add the plugin

//default options var options = { ...flexSearchIndexOptions, previewLength: 62, buttonLabel: "Search", placeholder: "Search docs", allow: [], ignore: [], };

export default defineConfig({ plugins: [SearchPlugin(options)], });


- Using config.js or config.ts
```js
import { SearchPlugin } from "vitepress-plugin-search";
import { defineConfig } from "vitepress";
export default defineConfig({
  vite: { plugins: [SearchPlugin(options)] }
});

Options

Accept FlexSearch Index Options

Multi language support

Provided by flexsearch

See chinese settings for example