Introduction to plugins
How to add Jekyll plugins to your site
Algolia is a hosted search platform you can use on your Jekyll site. They offer high performance search which can be customised to your usecase and even provide a Jekyll plugin to help you index your content. If your site has under 10,000 searches a month you can use Algolia for free.
source 'https://rubygems.org' gem 'jekyll', '3.3.1' group :jekyll_plugins do gem 'algoliasearch-jekyll' end
Add your algolia Application ID and index name to
algolia: application_id: 'your_application_id' index_name: 'your_index_name'
ALGOLIA_API_KEYor in a file called
_algolia_api_key. If you use the file method make sure it’s not checked into a public repository otherwise anyone could add content to your search. For the environment variable you can simply prefix the command with it, for example:
ALGOLIA_API_KEY='YOUR KEY' bundle exec jekyll algolia push
To generate an index and push it to Algolia you can use the
bundle exec jekyll algolia push
The plugin allows you to complete configure what pages are index, the content in those pages and index settings. Check out the documentation for more information.
CloudCannon has everything you need to build, host and update Jekyll websites.