vitepress-plugin-search

vitepress-plugin-search 是为 vitepress 开发的插件, 用于为文档网站提供本地搜索功能。

安装

npm i vitepress-plugin-search flexsearch -D

配置

使用 vite.config

在你的 vite.config.ts 中：

// vite.config.ts
import { SearchPlugin } from "vitepress-plugin-search";
import { defineConfig } from "vite";

// flexsearch 的索引选项
const flexSearchIndexOptions = {
    preset: 'speed',  // 优化速度
    tokenize: 'forward',  // 从左到右分词
    encoder: 'icase',  // 忽略大小写
    doc: {
        id: 'id',
        field: ['title', 'content']
    },
    threshold: 0.5,  // 设置匹配阈值
    cache: true  // 启用缓存
}

// 默认选项
const options = {
    ...flexSearchIndexOptions,
    previewLength: 62,
    buttonLabel: "Search",
    placeholder: "Search docs",
    allow: [],
    ignore: [],
};

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

使用 config.js 或 config.[m]ts

在你的 config.js 或 config.[m]ts 文件中：

import { SearchPlugin } from "vitepress-plugin-search";
import { defineConfig } from "vite";

export default defineConfig({
  vite: { plugins: [SearchPlugin(options)] } // 这里的 'options' 同上
});