Skip to content
This repository has been archived by the owner on Jul 12, 2023. It is now read-only.

Provide local search to your documentation site.

License

Notifications You must be signed in to change notification settings

mil7/vitepress-plugin-search

 
 

Repository files navigation

Provides local search to your documentation site

Uses flexsearch.

Installing

npm i vitepress-plugin-search flexsearch -D

Add the plugin

//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",
};

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

Options

Accept FlexSearch Index Options

Multi language support

Provided by flexsearch

See chinese settings for example

About

Provide local search to your documentation site.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Vue 59.0%
  • TypeScript 40.8%
  • JavaScript 0.2%