Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/androiddevelop/hexo-search
hexo search component
https://github.com/androiddevelop/hexo-search
hexo hexo-search
Last synced: 25 days ago
JSON representation
hexo search component
- Host: GitHub
- URL: https://github.com/androiddevelop/hexo-search
- Owner: androiddevelop
- License: mit
- Created: 2016-11-29T14:53:15.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-01-13T16:03:52.000Z (almost 5 years ago)
- Last Synced: 2024-11-16T20:35:52.878Z (about 1 month ago)
- Topics: hexo, hexo-search
- Language: CSS
- Homepage: https://www.codeboy.me
- Size: 49.8 KB
- Stars: 7
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hexo-Search
#### hexo博客搜索插件 [English manual](./README_EN.md)
[](https://www.npmjs.com/package/hexo-search-data-plugin)
jekyll博客搜索插件请前往 [Jekyll-Search](https://github.com/androiddevelop/jekyll-search)
### 截图
### Demo
[https://www.codeboy.me](https://www.codeboy.me)
### 操作
1. 点击右下角图标进行搜索
2. 双击ctrl键进行搜索或关闭
3. 搜索页面中点击右上角关闭按钮进行关闭
### 加入步骤
1. 安装搜索插件:
```
npm install hexo-search-data-plugin --save
```
或者在 `package.json` 中添加一下依赖：
```
"hexo-search-data-plugin":"^1.1.1"
```
之后执行`npm update`即可
2. 将search目录放至于hexo主题的`source`文件夹下，其中search目录结构如下:
search
├── cb-footer-add.html
├── css
│ └── cb-search.css
├── img
│ ├── cb-close.png
│ └── cb-search.png
└── js
├── bootstrap3-typeahead.min.js
└── cb-search.js
3. 在当前主题的 `layout/_partial/after-footer.ejs` 中的末尾加入 `cb-footer-add.html` 中的内容即可, 添加完毕后, `cb-footer-add.html` 文件可以删除。
> 如果主题不存在 `after-footer.ejs` 文件，也可以添加在 `footer.ejs` 中。
### 注意事项
1. `bootstrap3-typeahead.min.js` 的引入必须在 `jquery.min.js` 引入之后!
2. 默认联想8个，如果需要更多的话，请检索 `bootstrap3-typeahead.min.js` 中的 **items:8** , 将 **8** 替换成自己需要的数值。
3. 文章标题请不要使用回车等符号，回车等符号会造成json解析错误。
### 更新历史
#### v1.1.1
- 支持标题中含有双引号。
#### v1.1.0
- 更新npm信息。
#### v1.0.1
- 添加错误console输出。搜索没提示，看console。
#### v1.0.0
- 支持hexo博客中进行文章搜索。
## License
```
Copyright 2016 Yuedong.li
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
> 有任何问题,欢迎发送邮件到[email protected]交流.