vitepress-plugin-search

Provide local search to your documentation site.

MIT 21 个版本

vitepress search offline

主页

仓库

提交 Issue

安装

npm install vitepress-plugin-search

yarn add vitepress-plugin-search

pnpm add vitepress-plugin-search

bun add vitepress-plugin-search

README

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

//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

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

版本列表

1.0.4-alpha.22 2024-01-05

1.0.4-alpha.21 2023-12-09

1.0.4-alpha.20 2023-04-06

1.0.4-alpha.19 2023-01-30

1.0.4-alpha.18 2023-01-22

1.0.4-alpha.17 2022-12-16

1.0.4-alpha.16 2022-12-06

1.0.4-alpha.15 2022-11-03

1.0.4-alpha.14 2022-10-28

1.0.4-alpha.13 2022-10-28

1.0.4-alpha.11 2022-09-28

1.0.4-alpha.10 2022-09-28

1.0.4-alpha.9 2022-09-28

1.0.4-alpha.8 2022-09-25

1.0.4-alpha.7 2022-09-14

1.0.4-alpha.6 2022-09-12

1.0.4-alpha.5 2022-09-12

1.0.4-alpha.4 2022-09-10

0.0.3 2022-05-20

0.0.2 2022-05-19

0.0.1 2022-05-18