# gitbook-plugin-search-pro

**Repository Path**: sdk-apis/gitbook-plugin-search-pro

## Basic Information

- **Project Name**: gitbook-plugin-search-pro
- **Description**: gitbook 中文搜索插件
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-10
- **Last Updated**: 2021-10-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## gitbook-plugin-search-pro

Gitbook search engine pro. (支持中文搜索)





You can search any characters(utf-8) and highlight it in your GitBook, not only english(exp:Chinese).

> Note: Only gitbook >= 3.0.0 support

### Demo preview

ONLINE DEMO:

http://gitbook-plugins.github.io/gitbook-plugin-search-pro/book/

### GIFs

---

 

---

### Usage

Before use this plugin, you should disable the default search plugin first, 
Here is a `book.js` configuration example:

```js
{
    "plugins": [
      "-lunr", "-search", "search-pro"
    ]
}
```

### Example

After installed gitbook.
    
```
    > git clone git@github.com:gitbook-plugins/gitbook-plugin-search-pro.git -b gh-pages
    > cd ./gitbook-plugin-search-pro
    > npm install
    > gitbook serve ./
```

And then open http://127.0.0.1:4000


### Thanks:
* [lwdgit](https://github.com/lwdgit/gitbook-plugin-search-plus)
* [gitbook-plugin-lunr](https://github.com/GitbookIO/plugin-lunr)
* [gitbook-plugin-search](https://github.com/GitbookIO/plugin-search)
* [mark.js](https://github.com/julmot/mark.js)