Provides local search to your documentation site
Uses flexsearch.
Installing
npm i vitepress-plugin-search flexsearch -D
Add the plugin
- Using an vite.config file ```js //vite.config.ts import { SearchPlugin } from "vitepress-plugin-search"; import { defineConfig } from "vite";
//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