Algoliasearch Jekyll

screenshot of Algoliasearch Jekyll

Algoliasearch Jekyll

⚠ DEPRECATED Use jekyll-algolia instead.

Overview:

The Algolia Jekyll Plugin is a gem that has been deprecated in favor of jekyll-algolia. The plugin allows users to integrate Algolia's search functionality into their Jekyll websites. However, the gem is no longer being actively developed, and users are encouraged to transition to the new jekyll-algolia gem, which is officially supported by Algolia and comes with comprehensive documentation.

Features:

  • Integration of Algolia's search functionality into Jekyll websites
  • Improved search experience for users
  • Faster and more efficient search results

Installation:

Since the Algolia Jekyll Plugin has been deprecated, users are advised to follow the steps below to install and use the new jekyll-algolia gem:

  1. Install the jekyll-algolia gem by running the following command in your terminal:

    gem install jekyll-algolia
    
  2. Add the following line to your Jekyll website's Gemfile:

    gem 'jekyll-algolia'
    
  3. Run the following command to install the gem and its dependencies:

    bundle install
    
  4. Configure the jekyll-algolia gem by adding the required settings to your Jekyll website's _config.yml file. Refer to the documentation for more information on the available configuration options.

  5. Run the following command in your terminal to index your Jekyll website:

    bundle exec jekyll algolia push
    
  6. The jekyll-algolia gem will push your Jekyll website's content to Algolia's search index. You can now use Algolia's search functionality on your Jekyll website.

Summary:

The Algolia Jekyll Plugin is a deprecated gem that allows users to integrate Algolia's search functionality into their Jekyll websites. It has been replaced by the new jekyll-algolia gem, which is officially supported by Algolia and offers a more comprehensive solution for integrating Algolia's search functionality into Jekyll websites. Users are encouraged to migrate from the deprecated Algolia Jekyll Plugin to the new jekyll-algolia gem for a better and more up-to-date search experience on their Jekyll websites.