HEXO博客系统添加搜索功能

发表于 更新于 分类于 阅读次数： Changyan： 本文字数： 1.6k 阅读时长 ≈ 1 分钟
Hexo 可以通过接入第三方搜索引擎来为博客添加搜索功能。这里给出一种基于 Algolia 搜索引擎的实现方式。

Hexo 可以通过接入第三方搜索引擎来为博客添加搜索功能。这里给出一种基于 Algolia 搜索引擎的实现方式。

流程

Algolia 是一家搜索解决方案提供商，提供强大的搜索服务和 API 接口。在 Algolia 上搭建一个搜索服务的流程大致如下：

  1. 在 Algolia 上注册账号并创建一个应用；

  2. 将博客文章的信息导入 Algolia 中，可以使用 hexo-algolia 插件来实现，具体实现方式可以参考官方文档；

  3. 在博客页面中添加搜索框和搜索结果页面，利用 Algolia 提供的 API 进行搜索查询和结果展示。

具体步骤

以下是实现的具体步骤：

在 Algolia 上注册账号并创建一个应用

在 Algolia 上注册账号并创建一个应用，获取应用的 Application ID 和 API Key。

在 Hexo 中安装 hexo-algolia 插件

在本地 Hexo 目录中安装 hexo-algolia 插件。

1
$ npm install hexo-algolia --save

在 Hexo 中配置 hexo-algolia 插件

配置 hexo-algolia 插件

修改 Hexo 的配置文件 _config.yml，增加 Algolia 搜索的配置信息，如下所示：

1
2
3
4
5
6
7
8
9
10
algolia:
  applicationID: YOUR_APP_ID
  apiKey: YOUR_API_KEY
  indexName: hexo
  fields:
    - title
    - content
    - url
  debug: false
  concurrent: 2

其中，applicationID 和 apiKey 分别是应用的 Application ID 和 API Key；indexName 是在 Algolia 中创建的索引名称，需要与 hexo-algolia 中 algolia_index_name 的值相同；fields 表示要导入 Algolia 中的字段，这里选择了标题、正文和 URL 这三项；debug 表示是否开启调试模式，concurrent 表示并发导入的文章数量。

添加环境变量

添加HEXO_ALGOLIA_INDEXING_KEY环境变量，值为 Algolia 的 Admin API Key。这里需要注意的是，Admin API Key 是一个非常重要的密钥，不应该将其暴露在公开的仓库中，因此需要将其添加到环境变量中，而不是直接写在配置文件中。

直接在命令行中添加环境变量：
1
export HEXO_ALGOLIA_INDEXING_KEY=YOUR_ADMIN_API_KEY
在 Windows 系统中添加环境变量：

右键点击我的电脑 > 属性 > 高级系统设置 > 环境变量

在系统变量中新建一个变量，变量名为 HEXO_ALGOLIA_INDEXING_KEY，变量值为 YOUR_ADMIN_API_KEY。

在 macOS 系统中添加环境变量：

这里推荐在用户目录下的 .bash_profile 文件中添加环境变量，具体操作如下：

打开用户目录下的 .bash_profile 文件：

1
vim ~/.bash_profile

在文件末尾添加环境变量：

1
export HEXO_ALGOLIA_INDEXING_KEY=YOUR_ADMIN_API_KEY

保存退出后，执行以下命令使环境变量生效：

1
$ source ~/.bash_profile

配置放开搜索框和搜索页面

在 _config.yml 中增加搜索框的配置信息，如下所示：

1
2
3
search:
  path: search.xml
  field: all

其中，path 表示搜索结果页面的路径，这里设置为 search.xml；field 表示要搜索的字段，这里设置为 all 表示搜索所有字段。

在 Hexo 中安装 hexo-generator-search 插件，用于生成搜索结果页面。可以使用以下命令进行安装：

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

最后，重新生成站点，并在博客页面中测试搜索功能是否可用。

本文永久链接: https://www.mulianju.com/hexo-search/