https://github.com/aispin/hexo-generator-lunr
Lunr index generator plugin for Hexo
https://github.com/aispin/hexo-generator-lunr
Last synced: 24 days ago
JSON representation
Lunr index generator plugin for Hexo
- Host: GitHub
- URL: https://github.com/aispin/hexo-generator-lunr
- Owner: mamboer
- License: mit
- Created: 2015-11-23T12:57:43.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-09-07T10:37:37.000Z (over 8 years ago)
- Last Synced: 2024-11-07T04:50:18.856Z (7 months ago)
- Language: JavaScript
- Size: 6.84 KB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hexo-generator-lunr
Lunr index generator plugin for Hexo, compatible with Chinese.
## How to use
In your `_config.yml`, add the following configs.
```
# lunr
## field - post | page | all, default is all
## fulltext - If fulltext is true, lunr will index the whole post's `content`, or `title` and `excerpt` will be indexed only. If you use full text index, the generation will be slow.
## path - where should lunr put it's indexed data
lunr:
field: all
fulltext: false
path: assets/lunr/
```
## About Lunr.js
> Simple full-text search in your browser
For more details about Lunr.js, please check out the [Lunr.js](http://lunrjs.com/) official site.
In order to make Lunr to be compatible with Chinese, hexo-generator-lunr uses this forked version [mamboer/lunr.js](https://github.com/mamboer/lunr.js).