为Hexo blog博客创建本地搜索引擎

刚开始使用github+hexo建立blog博客。参考了不少文章,发现大部分作者采用的主题为iissan 创建的 NexT。NexT 主题默认提供了两个站内搜索解决方案:swiftype 和 tinysou,所以大都比较好配置。
对于不想使用NexT主题,然而喜欢的主题又没有提供站内搜索方案的时候,可能就比较折腾了。有人不想使用swiftype 和 tinysou方法也可能是基于某些其他原因:

  • 不愿意受限于第三方服务:第三方服务随时可能完蛋,风险大受限多。原本建独立博客目的就是为了不受限,如此这般, swiftype 就是如此原因;
  • 第三方服务样式单一;
  • 第三方服务,需要应用第三方JS,存在安全问题;
    后经过大量搜索查询,发现目前Hexo已经有比较满意的解决方法了。

1. 基本思路

  • Step1: 生成索引文件;
  • Step2: 有效的算法:根据用户输入的检索词,返回包含检索词的文章列表;
  • Step3 :使用 JavaScript 和 jQuery 来实现在浏览器中执行算法;
  • Step4 :在页面的合适位置展示搜索框和输出结果;
  • Step5 :美化。

2. 使用 hexo-generator-search 生成索引文件

这一步在网上大部分文章中都有提及,安装 hexo-generator-search 的生成器,在执行 hexo generate 的过程中,会按照配置生成一个 XML 文件,用于保存全站的文档数据。这个 XML 文件只是简单地做了数据的结构化存储,而完全没有考虑分词、倒排等问题。
安装 hexo-generator-search

npm install --save hexo-generator-search

在站点配置文件 _config.yml 当中写入如下配置,即可为全站的文档生成索引文件

search:
  path: search.xml
  field: post

hexo-generator-search 会为全站所有 post 类型的页面生成结构化的数据,并保存在本站的 /search.xml 当中。若想让 page 类型的页面也纳入索引,则可以将 field 的值修改为 all。

3. 使用 JavaScript 和 jQuery 实现检索算法

以 jQuery 的文本匹配为基础,在前端界面上运行站内搜索。文件在这里local_search.js。主要的处理流程是:

  • 载入 search.xml;
  • 解析 search.xml;
  • 解析检索词;
  • 在索引中进行字符串匹配;
  • 展现结果。

search.js 依赖 jQuery。因此,你需要在引入 search.js 之前,引入 jQuery 的脚本。比如,你可以在 head 部分这样做:<script src="//cdn.bootcss.com/jquery/3.2.1/jquery.min.js"></script>。

4. 在页面的合适位置展示搜索框和输出结果

<form class="site-search-form">
    <input type="text" id="local-search-input" class="st-search-input" />
</form>
<div id="local-search-result" class="local-search-result-cls"></div>

local-search-input 是一个输入框,用于接收用户输入的检索词;local-search-result 是用于展现搜索结果的 div 标签。这部分代码参考: hexo-search-plugin-snippets

5. 调用函数

现在,已经有了索引文件搜索算法搜索框。但是,现在而言,搜索框是孤立的:用户在搜索框中输入内容,并不会触发搜索算法。换而言之,搜索函数并没有调用。因此,我们需要调用定义在 search.js 当中定义的 searchFunc。

var path = "/search.xml";
searchFunc(path, 'local-search-input', 'local-search-result');

在网上找到了两位老师分享这种方法,但是您们没告诉小白要把这个东西写到哪儿才能起到调用的做用。解答如下:在你的layout文件中script最多的地方加入这么一句话:

<script type="text/javascript" src="/js/local_search.js"></script>

/js/local_search.js是你项目文件的地址。

6. 美化

Liam0205 提供 search.stylus 的样式。样式美化,每个人想法不一样,开心就好。

参考资料

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,636评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,890评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,680评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,766评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,665评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,045评论 1 276
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,515评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,182评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,334评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,274评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,319评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,002评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,599评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,675评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,917评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,309评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,885评论 2 341

推荐阅读更多精彩内容