hexo-generator-searchdb

hexo-generator-searchdb

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 JSON and XML format output. The JSON format is recommended, as it has a smaller size and avoids encoding issues.

Install

npm install hexo-generator-searchdb

Options

You can configure this plugin in your root _config.yml. All the arguments are optional.

search:
  path: search.json
  field: post
  content: true
  format: striptags

• path - the path to the generated database file. Supports .json and .xml formats. If no file extension is provided, JSON format will be used by default.
• 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:
  • striptags (Default) - original html string being minified, and remove all the tags.
  • html - original html string being minified.
  • raw - markdown text of each posts or pages.

FAQ

What's this plugin supposed to do?

This plugin is used for generating a JSON / XML 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 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.