Jekyll Algolia Plugin

Add fast and relevant search to your Jekyll site.

> While this plugin was created by Algolia, it is not an officially supported API client. It is possible that future major versions of Jekyll break compatibility, or require changes.

Usage

$ bundle exec jekyll algolia

This will push the content of your Jekyll website to your Algolia index.

Documentation

Full documentation can be found on
https://community.algolia.com/jekyll-algolia/

Installation

The plugin requires at least Jekyll 3.6.0 and Ruby 2.3.0.

First, add the jekyll-algolia gem to your Gemfile, in the :jekyll_plugins
section.

# Gemfile

group :jekyll_plugins do
  gem 'jekyll-algolia', '~&gt; 1.0'
end

Once this is done, download all dependencies with bundle install.

Basic configuration

You need to provide certain Algolia credentials for this plugin to index your
site.

If you don’t yet have an Algolia account, we suggest that you open a free
Community plan here. You can find more information about the Algolia plans
in our FAQ.

Once signed in, you should get your application ID from your dashboard and
define it inside your _config.yml file like this:

# _config.yml

algolia:
  application_id: 'your_application_id'

Run it

Once your application ID is setup, you can run the indexing by running the
following command:

ALGOLIA_API_KEY='your_admin_api_key' bundle exec jekyll algolia

Note that ALGOLIA_API_KEY should be set to your admin API key.

More about the Community plan

The Algolia Community plan lets you host up to 10k records and perform up
to 100k add/edit/delete operations per month (search operations are free). The
plan is entirely free, with no time limit.

What we ask in exchange is that you display a “Search by Algolia” logo next to
your search results. Our InstantSearch libraries have a simple boolean
option to toggle that on an off. If you want more flexibility, you can find
all versions of our logo here.

If you need more information about the other Algolia plans, you can check our
FAQ.

Thanks

Thanks to Anatoliy Yastreb for a great tutorial on creating Jekyll
plugins.

Modules

Classes