https://github.com/caibingcheng/hugo-algolia2

用于静态网站, 自动构建索引以及推送至algolia
https://github.com/caibingcheng/hugo-algolia2

algolia hugo

Last synced: about 2 months ago
JSON representation

用于静态网站, 自动构建索引以及推送至algolia

• Host: GitHub
• URL: https://github.com/caibingcheng/hugo-algolia2
• Owner: caibingcheng
• Created: 2021-09-26T02:29:10.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-11-10T12:25:59.000Z (about 3 years ago)
• Last Synced: 2024-10-19T20:41:21.404Z (3 months ago)
• Topics: algolia, hugo
• Language: JavaScript
• Homepage:
• Size: 88.9 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# hugo-algolia2

项目改编自[hugo-algolia](https://github.com/replicatedhq/hugo-algolia), 用于hugo静态内容的搜索.

### New Features

- 修复原项目的一些问题

- 支持自定义URI格式

- 支持按照文件后缀过滤

- 去除无用单词

- 添加中文分词

### Installation

从[npm](https://npmjs.org)安装`hugo-algolia2`

```

npm install hugo-algolia2

```

或者

```

yarn add hugo-algolia2

```

### How does it work?

默认遍历hugo项目的`/content`路径下的文件, 并且按照['html','md']后缀过滤, 并且在`/public`下生成`algolia.json`. 具体配置参数可以使用`hugo-algolia2 --help`.

### Sending to Algolia

在hugo项目根目录下添加配置文件`config.yaml`, 如下:

```

---

baseURL: /

uri: :year:month/:slug

algolia:

  index: "index-name"

  key: "[your API key]"

  appID: "[your app id]"

---

```

URI是访问路径, 需要和hugo的配置相同. key需要填写Admin API Key.

配置之后,

```

hugo-algolia2 -s

```

可以上传algolia配置.

### Github Action

```

name: deploy

on:

  push:

  workflow_dispatch:

jobs:

  generate-algolia:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

      - uses: caibingcheng/hugo-algolia2@v1

        with:

          input: "./posts/**"

          output: "./algolia.json"

          index: ${{ secrets.ALGOLIA_INDEX }}

          apikey: ${{ secrets.ALGOLIA_APIKEY }}

          appid: ${{ secrets.ALGOLIA_APPID }}

```

# License

同[hugo-algolia](https://github.com/replicatedhq/hugo-algolia), 本项目也使用ISC License.