Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theme-next/hexo-generator-searchdb
Seach data generator plugin for Hexo.
https://github.com/theme-next/hexo-generator-searchdb
generator hexo search
Last synced: about 2 months ago
JSON representation
Seach data generator plugin for Hexo.
- Host: GitHub
- URL: https://github.com/theme-next/hexo-generator-searchdb
- Owner: theme-next
- License: mit
- Archived: true
- Created: 2018-01-19T11:33:14.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-09-13T02:03:47.000Z (over 3 years ago)
- Last Synced: 2024-08-02T09:26:07.545Z (5 months ago)
- Topics: generator, hexo, search
- Language: JavaScript
- Homepage:
- Size: 10.7 KB
- Stars: 44
- Watchers: 13
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**Deprecated: [new repository in here](https://github.com/next-theme/hexo-generator-searchdb)**
# hexo-generator-searchdb
[![npm-image]][npm-url]
[![node-image]][node-url]
[![hexo-image]][hexo-url]
[![lic-image]](LICENSE)
Seach data generator plugin for Hexo.
This plugin is used for generating a search index file, which contains all the necessary data of your articles that you can use to write a local search engine for your blog. Supports both XML and JSON format output.
## Install
![size-image]
[![dm-image]][npm-url]
[![dt-image]][npm-url]
``` bash
$ npm install hexo-generator-searchdb
```
## Options
You can configure this plugin in your root `_config.yml`. All the arguments are optional.
``` yaml
search:
path: search.xml
field: post
content: true
format: html
```
- **path** - file path. By default is `search.xml`. If the file extension is `.json`, the output format will be JSON. Otherwise XML format file will be exported.
- **field** - the search scope you want to search, you can chose:
* **post** (Default) - will only cover all the posts of your blog.
* **page** - will only cover all the pages of your blog.
* **all** - will cover all the posts and pages of your blog.
- **content** - whether contains the whole content of each article. If `false`, the generated results only cover title and other meta info without mainbody. By default is `true`.
- **format** - the form of the page contents, options are:
* **html** (Default) - original html string being minified.
* **striptags** - original html string being minified, and remove all the tags.
* **raw** - markdown text of each posts or pages.
## FAQ
### What's this plugin supposed to do?
This plugin is used for generating a xml / json file from your Hexo blog that provides data for searching.
### Where's this file saved to?
After executing `hexo g` you will get the generated result at your public folder.
### How to use this plugin in my Hexo blog?
You have two choices:
* you don't want to write search engine by yourself. There are many themes that take use this plugin for local searching that works out of box.
* you are familiar with fetch API or jQuery Ajax and would like to write your own search engine. You can implement one by yourself according to the theme NexT. Read the [source code](https://github.com/theme-next/hexo-theme-next) of this theme. Generally there are 3 steps:
1. write a [search view](https://github.com/theme-next/hexo-theme-next/blob/v7.5.0/layout/_partials/search/localsearch.swig). This is the place for displaying a search form and search results ;
2. write a [search script](https://github.com/theme-next/hexo-theme-next/blob/v7.5.0/source/js/local-search.js). This script tells the browser how to grab search data and filter out contents what we're searching;
3. tell hexo to [connect the above two part](https://github.com/theme-next/hexo-theme-next/blob/v7.5.0/layout/_third-party/search/localsearch.swig).
[npm-image]: https://img.shields.io/npm/v/hexo-generator-searchdb?style=flat-square
[node-image]: https://img.shields.io/node/v/hexo-generator-searchdb?style=flat-square
[hexo-image]: https://img.shields.io/badge/hexo-%3E%3D%203.0-blue?style=flat-square
[lic-image]: https://img.shields.io/npm/l/hexo-generator-searchdb?style=flat-square
[size-image]: https://img.shields.io/github/languages/code-size/theme-next/hexo-generator-searchdb?style=flat-square
[dm-image]: https://img.shields.io/npm/dm/hexo-generator-searchdb?style=flat-square
[dt-image]: https://img.shields.io/npm/dt/hexo-generator-searchdb?style=flat-square
[npm-url]: https://www.npmjs.com/package/hexo-generator-searchdb
[node-url]: https://nodejs.org/en/download/releases
[hexo-url]: https://hexo.io