hexo-generator-search-cst

Generate search data for Hexo 3.0. This plugin is used for generating a search index file, which contains all the neccessary data of your articles that you can use to write a local search engine for your blog. Supports both XML and JSON format output.

• Demo - try out the search engine in this site.
• Demo JSON output
• Demo XML output

重要说明

由于nunjucks模板引擎不兼容emberjs的{{}}标签，所以修改了nunjucks模板引擎的标签占位符。

| nunjucks默认占位符 | 修改后的占位符 | | ---------------- | ------------- | | {{ | {$ | | }} | $} | | {# | {@ | | #} | @} |

修改后使用nunjucks模板引擎解析的hexo插件会解析失败，所以需要同步修改依赖nunjucks模板引擎的hexo插件。

之所以这么做是因为hexo使用nunjucks解析生成静态HTML。然后我的主站xcoding使用了GitHub+hexo搭建。然后博客主要用于记录EmberJS相关文章，EmberJS很多标签都是使用{{}}，与模板引擎的占位符冲突。

冲突出现的问题如下：

http://hexo.io/docs/troubleshooting.html
Template render error: (unknown path) [Line 37, Column 81]
  expected variable end


Unhandled rejection Template render error: (unknown path) [Line 10, Column 95]
  unexpected token: #

当然也有其他解决方案，但是自定义模板占位符是比较好的方法，详细可以看如下博客： 如何从根本解决hexo不兼容{{}}标签问题

Install

$ npm install hexo-generator-search-cst --save

Options

You can configure this plugin in your root _config.yml.

search:
  path: search.xml
  field: post

• 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 covers all the posts of your blog.
  • page - will only covers all the pages of your blog.
  • all - will covers all the posts and pages of your blog.

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 Ajax and jQuery and would like to write your own search engine. You can implement one by yourself according to the example theme I give. Read the source code of this theme. Generally there are 3 steps:
  1. write a search view. This is the place for displaying a search form and search results ;
  2. write a search script. 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.