Jekyll Algolia

screenshot of Jekyll Algolia

Jekyll Algolia

Add fast and relevant search to your Jekyll site

Overview:

This plugin is a deprecated Algolia plugin for Jekyll. As of November 2022, it still works on Jekyll 3, but it is no longer maintained by Algolia. The plugin allows you to add fast and relevant search functionality to your Jekyll site by pushing the content of your site to your Algolia index.

Features:

  • Easy integration of fast and relevant search to a Jekyll site
  • Pushes the content of the Jekyll website to the Algolia index
  • Supports Jekyll 3.6.0 and Ruby 2.3.0

Installation:

To install the Jekyll Algolia plugin, follow these steps:

  1. Add the jekyll-algolia gem to your Gemfile, in the :jekyll_plugins section.
group :jekyll_plugins do
  gem 'jekyll-algolia'
end
  1. Download all dependencies by running bundle install in the terminal.

  2. Configure the Algolia credentials in your Jekyll site's _config.yml file, using your application ID provided by Algolia.

algolia:
  application_id: YOUR_APPLICATION_ID
  [...]
  1. Run the indexing by running the following command in the terminal, replacing ALGOLIA_API_KEY with your admin API key.
ALGOLIA_API_KEY=YOUR_ADMIN_API_KEY jekyll algolia

Summary:

The Jekyll Algolia plugin is a deprecated Algolia plugin that allows for the easy integration of fast and relevant search functionality to Jekyll sites. Although it is no longer maintained, it can still be used with Jekyll 3. The plugin requires Jekyll 3.6.0 and Ruby 2.3.0. To install the plugin, add the jekyll-algolia gem to your Gemfile, configure the Algolia credentials in your _config.yml file, and run the indexing command.