Algolia Search integration for Pelican

This Pelican plugin automatically indexes your posts with the Algolia cloud service.

You can find a live example here.

Each time you rebuild your site the plugin will update the indexes on the Algolia servers and remove any deleted documents.

Installation & Configuration

Create a free account with Algolia:

You do not need a credit card to create an account and it will be enabled immediately.

Clone this repository and add it to your plugin folder:

$ cd plugins
$ git clone https://github.com/srault95/pelican-algolia-search.git

Install requirements:

pip install algoliasearch beautifulsoup4

Enable & configure the plugin in your pelicanconf.py:

PLUGINS = [
    #...
    'algolia_search'
]

ALGOLIA_APP_ID = "[YOUR ALGOLIA APPID]"
ALGOLIA_SEARCH_API_KEY = "[YOUR ALGOLIA SEARCH API KEY]"
ALGOLIA_ADMIN_API_KEY = "[YOUR ALGOLIA ADMIN API KEY]"
ALGOLIA_INDEX_NAME = 'demoblog'

Build you own search page:

There are many ways to integrate the Algolia search widgets in your website. I chose to use vue-instantsearch.

I completely replaced the index.html template to put the search box on the index page. (index.html)

The Algolia documentation has all the necessary information and examples to get started.

Rebuild your website:

$ pelican