ChoDocs

外观

VitePress 添加本地搜索功能 ​

作者:fxzer
发表于:2023-02-19
更新于:6 个月前
字数统计:361 字
阅读时长:1 分钟

踩坑历程

折腾了三遍 Algolia 都没能添加上搜索功能，最后在找到了这个 issus 里大佬提供的解决方案，成功添加上了本地搜索功能。

Offline search functionality #670
https://github.com/vuejs/vitepress/issues/670

安装插件 ​

bash
npm i vitepress-plugin-search markdown-it flexsearch -D

添加和配置插件 ​

坑点

1.README 没写在哪个目录下存放vite.config.ts，依据经验放在根目录下不管用，放在.vitepress也不生效，最后挨个试才发现需要放在docs

README
https://github.com/emersonbottero/vitepress-plugin-search#readme

2.示例没有引入flexSearchIndexOptions，需要手动从flexsearch中引入

3.引入后发现之前搜索框样式没了，需要在.vitepress/theme/styles/index.css下重新覆盖样式

image-20230205233032922
typescript
//vite.config.ts
import { SearchPlugin } from "vitepress-plugin-search";
import { defineConfig } from "vite";
import flexSearchIndexOptions from "flexsearch";
//default options
var options = {
  ...flexSearchIndexOptions,
  previewLength: 100, //搜索结果预览长度
  buttonLabel: "搜索",
  placeholder: "情输入关键词",
};

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

样式覆盖 ​

css
.DocSearch-Button {
  display: flex;
  justify-content: center;
  align-items: center;
  margin: 0;
  padding: 0;
  width: 32px;
  height: 32px;
  border-radius: 4px;
  background: transparent;
  transition: border-color 0.25s;
}
@media (min-width: 768px) {
  .DocSearch-Button {
    justify-content: flex-start;
    border: 1px solid transparent;
    border-radius: 8px;
    padding: 0 10px 0 12px;
    width: 100%;
    height: 40px;
    background-color: var(--vp-c-bg-alt);
  }
}
@media (max-width: 768px) {
  .DocSearch-Button-Keys {
    display: none;
  }
  .VPNavBarHamburger {
    height: 32px !important;
    width: 32px !important;
    border-radius: 4px;
  }
}
.DocSearch-Button:hover {
  background-color: #f5f5f6;
}

Contributors ​

fxzer