Hugo使用algolia搜索

辛琪收录于类别博客

2021-08-04 2021-08-04 约 904 字预计阅读 2 分钟次阅读

Hugo使用algolia搜索

背景

在将hexo迁移到hugo后我就开始折腾博客搜索了，下面的配置正对loveit主题配置

开启algolia搜索

在config.toml中添加下面字段，xxxxx是必填，你可以参考loveit主题中的config.toml

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23


      # 搜索配置
      [languages.zh-cn.params.search]
        enable = true
        # 搜索引擎的类型 ("lunr", "algolia")
        type = "algolia"
        # 文章内容最长索引长度
        contentLength = 4000
        # 搜索框的占位提示语
        placeholder = ""
        # 最大结果数目
        maxResultLength = 10
        # 结果内容片段长度
        snippetLength = 50
        # 搜索结果中高亮部分的 HTML 标签
        highlightTag = "em"
        # 是否在搜索索引中使用基于 baseURL 的绝对路径
        absoluteURL = false
        [languages.zh-cn.params.search.algolia]
        # algolia注册的索引名称
          index = "xxxxx"      
        # 在你注册完成后，点击API Keys就能看见下面的参数          
          appID = "xxxxx"
          searchKey = "xxxxx"

自动提交索引到algolia

又又用到了npm,好在集成到travis中眼不见为净。

在config.toml同级目录下运行npm init，一路回车即可。

修改npm int生成的package.json添加下面字段

1
2
3
4


 "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "algolia": "atomic-algolia"
  },

在config.toml同级目录添加.env文件并添加下面字段

1
2
3
4


❯ cat .env
ALGOLIA_APP_ID=U9QMQ70DKL
ALGOLIA_INDEX_NAME=gaojila.github.io
ALGOLIA_INDEX_FILE=public/index.json

修改.travis.yml文件如下

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47


language: go

go:
  - "1.8"  # 指定Golang 1.8

install:
  # 安装最新的hugo
  - wget https://github.com/gohugoio/hugo/releases/download/v0.71.1/hugo_0.71.1_Linux-64bit.deb
  - sudo dpkg -i hugo*.deb
  # 安装搜索插件
  - npm install atomic-algolia --save-dev

script:
  # 运行hugo命令
  - hugo
  # 生成索引命令
  - echo "ALGOLIA_ADMIN_KEY=$ALGOLIA_ADMIN_KEY" >> .env
  - npm run algolia

after_script:
  # 部署
  - cd ./public
  - git init
  - git config user.name "[gaojila]"
  - git config user.email "[redgaojila@gmail.com]"
  - git add .
  - git commit -m "Update Blog By TravisCI With Build $TRAVIS_BUILD_NUMBER"
  # Github Pages
  - git push --force --quiet "https://$GITHUB_TOKEN@${GH_REF}" master:master
  # Github Pages
  - git push --quiet "https://$GITHUB_TOKEN@${GH_REF}" master:master --tags

env:
  global:
   # Github Pages
    - GH_REF: "github.com/gaojila/gaojila.github.io"

deploy:
  provider: pages # 重要，指定这是一份github pages的部署配置
  skip-cleanup: true # 重要，不能省略
  local-dir: public # 静态站点文件所在目录
  # target-branch: master # 要将静态站点文件发布到哪个分支
  github-token: $GITHUB_TOKEN # 重要，$GITHUB_TOKEN是变量，需要在GitHub上申请、再到配置到Travis
  # fqdn:  # 如果是自定义域名，此处要填
  keep-history: true # 是否保持target-branch分支的提交记录
  on:
    branch: master # 博客源码的分支

在travis中添加变量$ALGOLIA_ADMIN_KEY

参考链接

aligolia的其他配置可以看下面的链接

dreamsafari.info

nashome.cn