Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/QYueWang/vuepress-plugin-flexsearch-pro
支持多种语言（包括中文）全局搜索
https://github.com/QYueWang/vuepress-plugin-flexsearch-pro
Last synced: about 2 months ago
JSON representation
支持多种语言（包括中文）全局搜索
- Host: GitHub
- URL: https://github.com/QYueWang/vuepress-plugin-flexsearch-pro
- Owner: QYueWang
- License: mit
- Created: 2021-02-01T05:30:49.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-01-09T02:49:12.000Z (over 2 years ago)
- Last Synced: 2024-04-30T07:43:43.413Z (5 months ago)
- Language: Vue
- Size: 138 KB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vuepress-plugin-flexsearch-pro
本项目在[vuepress-plugin-flexsearch](https://github.com/z3by/vuepress-plugin-flexsearch.git)的基础上进行修改。可以替换vuepress自带的搜索控件，支持中文、英文、德文、韩文、日文的全文搜索。
## 安装
```bash
yarn add -D vuepress-plugin-flexsearch-pro
// or npm install vuepress-plugin-flexsearch-pro -D
```
## 使用
使用默认方式:
```js
// .vuepress/config.js
module.exports = {
plugins: [
['flexsearch-pro'],
// other plugins
]
}
```
或者自定义搜索参数:
```js
// .vuepress/config.js
module.exports = {
plugins: [
['flexsearch-pro', {
/*
自定义搜索参数
*/
searchPaths: ['path1', 'path2'], // 搜索路径数组，为空表示搜索全部路径
searchHotkeys: ['s'], // 激活搜索控件的热键, 默认是 "s" ，也可以添加更多热键
searchResultLength: 60, // 搜索结果展示的字符长度, 默认是60个字节
}],
// other plugins
]
}
```
## 修改说明
**config.js**
1、不再支持search_options自定义，不能定义flexsearch的Options参数，如需修改请到SearchBox.vue里修改参数适配。
2、去掉了maxSuggestions，一般全局搜索都展示所有的结果，不会限定搜索出来的结果。
**index.js**
将flexsearch的options定义放到了SearchBox.vue中。
**SearchBox.vue**
1、适配中英文搜索，依据搜索的关键词（query）判断是中文还是英文进行匹配FlexSearch实例。
2、修改呈现样式，增加滚动条。
## 呈现效果
## 感谢
Thanks to [nextapps-de/flexsearch](https://github.com/nextapps-de/flexsearch) and [vuepress-plugin-flexsearch](https://github.com/z3by/vuepress-plugin-flexsearch.git)