Add fast and relevant search to your Jekyll site
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github docs(issue): Updating the issue template Feb 14, 2018
docs-src docs(security): Update dependency relying on infected event-stream Dec 7, 2018
docs Updating documentation website Nov 19, 2018
lib release 1.4.9 Dec 14, 2018
scripts test(integration): Add custom site for testing plugin integration May 7, 2018
spec fix(shrinker): Pages without excerpts no longer crash Dec 14, 2018
.coveralls.yml test(coveralls): Add coverall files Jul 16, 2015
.gitignore test(integration): Add custom site for testing plugin integration May 7, 2018
.rspec test(rspec): Start adding rspec tests Jul 2, 2015
.rubocop.yml style(rubocop): Making Travis and Rubocop work better together Nov 28, 2017
.travis.yml test(travis): Enable Travis tests Nov 27, 2017
CONTRIBUTING.md docs(tests): Explain how to run integration tests Dec 7, 2018
Gemfile Refactoring skeleton, by splitting into specific classes Nov 7, 2017
Guardfile test(fix): Fix failing tests and watch script Apr 26, 2018
Guardfile_integration test(integration): Load rspec config in integration tests Mar 12, 2018
LICENSE Rename boilerplate to jekyll-algolia Dec 12, 2017
MAINTAINERS docs(maintainer): Adding the MAINTAINERS files Mar 22, 2018
README.md Fix readme Dec 7, 2018
Rakefile test(link): Add unit and integration tests for the link tag Apr 5, 2018
jekyll-algolia.gemspec fix(deps): Force using api client v1.24 because 1.25 is buggy Dec 19, 2018

README.md

Jekyll Algolia Plugin

gem version ruby jekyll build master build develop coverage master

Add fast and relevant search to your Jekyll site.

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', '~> 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.