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.
npm install hexo-generator-searchdb
You can configure this plugin in your root _config.yml
. All the arguments are optional.
search:
path: search.xml
field: post
content: true
format: html
search.xml
. If the file extension is .json
, the output format will be JSON. Otherwise XML format file will be exported.false
, the generated results only cover title and other meta info without mainbody. By default is true
.This plugin is used for generating a xml / json file from your Hexo blog that provides data for searching.
After executing hexo g
you will get the generated result at your public folder.
You have two choices:
you are familiar with JavaScript and would like to write your own search engine. You can implement one by yourself according to the template code search.js
. There is no documentation at present, but you can find its usage in the source code of the theme NexT. Generally there are 3 steps:
write a search view. This is the place for displaying a search form and search results;
load the search.js
script via CDN, for example:
<script src="https://cdn.jsdelivr.net/npm/hexo-generator-searchdb@1.4.0/dist/search.js"></script>
A LocalSearch
class is provided in the search.js
which tells the browser how to grab search data and filter out contents what we're searching;
write a search script, make use of the previous LocalSearch
class.