algolia-jekyll-action's Introduction

algolia-jekyll-action

This is a wrapper of the jekyll-algolia plugin.

🎉 GitHub Pages ready!

This action pushes all your content in an Algolia index.

Repo setup

Full reference on the jekyll-algolia documentation.

Install `jekyll-algolia`

You need to add jekyll-algolia to your Gemfile, as part of the :jekyll-plugins group.

Minimal Gemfile example:

source 'https://rubygems.org'

gem 'jekyll', '~> 3.6'

group :jekyll_plugins do
  gem 'jekyll-algolia'
end

Configuration

On your Algolia account (free Community plan available), get your credentials from your dashboard.

On your _config.yml, write:

algolia:
   application_id: YOUR_APPLICATION_ID
   index_name: YOUR_INDEX_NAME # You can replace that with whatever name you want
   search_only_api_key: YOUR_SEARCH_ONLY_API_KEY

Important: On your GitHub repo, go to Settings > Secrets and set a new secret:

Name	Value
`ALGOLIA_API_KEY`	`YOUR_ADMIN_API_KEY`

The Action

Create a workflow file (e.g. algolia-search.yml) in your-repo/.github/workflows/ directory, similar to:

on:
  push:
    branches:
      - master
      - main

name: algolia-search
jobs:
  algolia-search:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      
      - uses: ruby/setup-ruby@v1
        with:
          ruby-version: '2.6'
          bundler-cache: true
          
      - uses: actions/[email protected]
        with:
          path: vendor/bundle
          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
          restore-keys: |
            ${{ runner.os }}-gems-
            
      - name: Algolia Jekyll Action
        uses: dieghernan/algolia-jekyll-action@v1
        with:
          APIKEY: '${{ secrets.ALGOLIA_API_KEY }}'