# Jekyll-algolia plugin **URL:** \ **Category:** Share\ **Created:** [November 17, 2017, 3:58pm UTC](https://talk.jekyllrb.com/t/jekyll-algolia-plugin/1179 "2017-11-17T15:58:29Z")\ **Posts on this page:** 15\ **Page:** 1
**Author:** ![Frank](https://yyz2.discourse-cdn.com/flex030/user_avatar/talk.jekyllrb.com/frank/32/26_2.png) [@Frank](https://talk.jekyllrb.com/u/Frank)\ **Post date:** [November 17, 2017, 3:58pm UTC](https://talk.jekyllrb.com/t/jekyll-algolia-plugin/1179/1 "2017-11-17T15:58:29Z")
The official algolia plugin for jekyll is going through a major version bump, any feedback is welcomed before the v1.0 release. > **[algolia/jekyll-algolia](https://github.com/algolia/jekyll-algolia)** > > Add fast and relevant search to your Jekyll site. Contribute to algolia/jekyll-algolia development by creating an account on GitHub. To test the plugin, modify your Gemfile: ```ruby group :jekyll_plugins do gem 'jekyll-algolia' end ``` Add you application\_id and index in the config: ```auto algolia: application_id: 'xxxxxxxxx' index_name: 'my_index' ``` Then run `ALGOLIA_API_KEY=XXXXXXXX bundle exec jekyll algolia` to push your index to algolia. Front-end demo with Instant Search and examples coming soon. If you’re a theme developer and are interested in adding Algolia search to your theme and need any help, please ask on the repo. /cc @DavidDarnes, @desiredpersona, @mmistakes Of course you just have to [open an issue](https://github.com/algolia/jekyll-algolia/issues) on GitHub if you have any question/feedback. ---
**Author:** ![yashumittal](https://yyz2.discourse-cdn.com/flex030/user_avatar/talk.jekyllrb.com/yashumittal/32/1260_2.png) [@yashumittal](https://talk.jekyllrb.com/u/yashumittal)\ **Post date:** [November 19, 2017, 8:47am UTC](https://talk.jekyllrb.com/t/jekyll-algolia-plugin/1179/2 "2017-11-19T08:47:52Z")
Has anyone use `Jekyll-algolia plugin` yet? ---
**Author:** ![desiredpersona](https://yyz2.discourse-cdn.com/flex030/user_avatar/talk.jekyllrb.com/desiredpersona/32/18_2.png) [@desiredpersona](https://talk.jekyllrb.com/u/desiredpersona)\ **Post date:** [November 20, 2017, 7:16pm UTC](https://talk.jekyllrb.com/t/jekyll-algolia-plugin/1179/3 "2017-11-20T19:16:40Z")
Thanks for the heads up @Frank. Added a note to my ever-growing to-do list. Algolia search is quite useful on the Jekyll homepage. 👍 ---
**Author:** ![yashumittal](https://yyz2.discourse-cdn.com/flex030/user_avatar/talk.jekyllrb.com/yashumittal/32/1260_2.png) [@yashumittal](https://talk.jekyllrb.com/u/yashumittal)\ **Post date:** [November 24, 2017, 8:52am UTC](https://talk.jekyllrb.com/t/jekyll-algolia-plugin/1179/4 "2017-11-24T08:52:33Z")
@mmistakes, have you use this `Jekyll-algolia` plugin in the Jekyll Documentation? ![image](https://canada1.discourse-cdn.com/flex030/uploads/jekyllrb/original/1X/cf7348adc320cd76e147b4d748235b53d3ad8267.png) ---
**Author:** ![mmistakes](https://yyz2.discourse-cdn.com/flex030/user_avatar/talk.jekyllrb.com/mmistakes/32/2169_2.png) [@mmistakes](https://talk.jekyllrb.com/u/mmistakes)\ **Post date:** [November 24, 2017, 2:25pm UTC](https://talk.jekyllrb.com/t/jekyll-algolia-plugin/1179/5 "2017-11-24T14:25:10Z")
No, I haven’t tried it yet. ---
**Author:** ![Frank](https://yyz2.discourse-cdn.com/flex030/user_avatar/talk.jekyllrb.com/frank/32/26_2.png) [@Frank](https://talk.jekyllrb.com/u/Frank)\ **Post date:** [November 24, 2017, 5:26pm UTC](https://talk.jekyllrb.com/t/jekyll-algolia-plugin/1179/6 "2017-11-24T17:26:19Z")
For Jekyll’s documentation we opted for the [DocSearch](https://community.algolia.com/docsearch/) service because GitHub Pages do not support this plugin by default. The plugin is still in development and currently already handles indexation at build time, for the front-end you still have to use a library like [InstantSearch](https://community.algolia.com/instantsearch.js/). Maybe the plugin will allow easier integration in the future. ---
**Author:** ![DavidDarnes](https://yyz2.discourse-cdn.com/flex030/user_avatar/talk.jekyllrb.com/daviddarnes/32/1349_2.png) [@DavidDarnes](https://talk.jekyllrb.com/u/DavidDarnes)\ **Post date:** [December 7, 2017, 11:42pm UTC](https://talk.jekyllrb.com/t/jekyll-algolia-plugin/1179/7 "2017-12-07T23:42:52Z")
Looks great! Sorry for my late reply, been quite busy. I’d like to test it out on a project that justifies it. I’m doing my best to keep my themes working well both in and out of the GitHub Page ecosystem so I’m not so keen to add it to them, sorry. ---
**Author:** ![Frank](https://yyz2.discourse-cdn.com/flex030/user_avatar/talk.jekyllrb.com/frank/32/26_2.png) [@Frank](https://talk.jekyllrb.com/u/Frank)\ **Post date:** [December 19, 2017, 10:07pm UTC](https://talk.jekyllrb.com/t/jekyll-algolia-plugin/1179/8 "2017-12-19T22:07:19Z")
Here is a [snapshot preview of the jekyll-algolia plugin integration with Jekyll’s default theme](https://cl.ly/372d1p2O1B1V) ---
**Author:** ![Frank](https://yyz2.discourse-cdn.com/flex030/user_avatar/talk.jekyllrb.com/frank/32/26_2.png) [@Frank](https://talk.jekyllrb.com/u/Frank)\ **Post date:** [December 20, 2017, 4:29pm UTC](https://talk.jekyllrb.com/t/jekyll-algolia-plugin/1179/9 "2017-12-20T16:29:58Z")
Demo is now available: [https://community.algolia.com/jekyll-algolia-example/](https://community.algolia.com/jekyll-algolia-example/) ---
**Author:** ![rdyar](https://yyz2.discourse-cdn.com/flex030/user_avatar/talk.jekyllrb.com/rdyar/32/710_2.png) [@rdyar](https://talk.jekyllrb.com/u/rdyar)\ **Post date:** [December 20, 2017, 8:09pm UTC](https://talk.jekyllrb.com/t/jekyll-algolia-plugin/1179/10 "2017-12-20T20:09:08Z")
that is really cool! ---
**Author:** ![Frank](https://yyz2.discourse-cdn.com/flex030/user_avatar/talk.jekyllrb.com/frank/32/26_2.png) [@Frank](https://talk.jekyllrb.com/u/Frank)\ **Post date:** [December 21, 2017, 7:47pm UTC](https://talk.jekyllrb.com/t/jekyll-algolia-plugin/1179/11 "2017-12-21T19:47:38Z")
Documentation is available for those who wants to add search on their blog: > **[Algolia for Jekyll](https://community.algolia.com/jekyll-algolia/blog.html)** > > Add fast and relevant search to your Jekyll site Also you’ll find how to deploy on GitHub Pages with Travis and on Netlify (recommended default) More examples to come for documentation and collections, stay tuned! ---
**Author:** ![Frank](https://yyz2.discourse-cdn.com/flex030/user_avatar/talk.jekyllrb.com/frank/32/26_2.png) [@Frank](https://talk.jekyllrb.com/u/Frank)\ **Post date:** [February 1, 2018, 5:31pm UTC](https://talk.jekyllrb.com/t/jekyll-algolia-plugin/1179/12 "2018-02-01T17:31:34Z")
The new plugin has been officially released, it has been tested by some members of the community so it’s already pretty solid. The indexation is now smarter and will save operations on your quota, that also makes updates faster. You’re encouraged to upgrade 🚀 > **[New Features, New Docs and a New Foundation for Algolia’s Jekyll Plugin](https://blog.algolia.com/new-features-for-jekyll-search-plugin/)** > > We’re proud to announce the new release of our Jekyll plugin, jekyll-algolia. Jekyll is the best-known static website generator, converting raw markdown content to beautiful HTML pages. This plugin… ---
**Author:** ![mmistakes](https://yyz2.discourse-cdn.com/flex030/user_avatar/talk.jekyllrb.com/mmistakes/32/2169_2.png) [@mmistakes](https://talk.jekyllrb.com/u/mmistakes)\ **Post date:** [February 16, 2018, 3:34pm UTC](https://talk.jekyllrb.com/t/jekyll-algolia-plugin/1179/13 "2018-02-16T15:34:02Z")
Just got around to adding support for jekyll-algolia in my [**Basically Basic theme**](https://github.com/mmistakes/jekyll-theme-basically-basic) (more to follow 🙂) And here’s a [demo site](https://mmistakes.github.io/jekyll-theme-basically-basic-algolia-search/) of it in use on GitHub Pages, with the [help of Travis CI](https://community.algolia.com/jekyll-algolia/github-pages.html). ---
**Author:** ![rdyar](https://yyz2.discourse-cdn.com/flex030/user_avatar/talk.jekyllrb.com/rdyar/32/710_2.png) [@rdyar](https://talk.jekyllrb.com/u/rdyar)\ **Post date:** [February 16, 2018, 11:25pm UTC](https://talk.jekyllrb.com/t/jekyll-algolia-plugin/1179/14 "2018-02-16T23:25:34Z")
That’s pretty cool! Found this nugget on the Basically Basic site: > [@](#): > > The best way to demonstrate the ebb and flow of the various image positioning options is to nestle them snuggly among an ocean of words. Grab a paddle and let’s get started. ---
**Author:** ![mmistakes](https://yyz2.discourse-cdn.com/flex030/user_avatar/talk.jekyllrb.com/mmistakes/32/2169_2.png) [@mmistakes](https://talk.jekyllrb.com/u/mmistakes)\ **Post date:** [February 17, 2018, 12:53am UTC](https://talk.jekyllrb.com/t/jekyll-algolia-plugin/1179/15 "2018-02-17T00:53:14Z")
I can’t take all the credit for that copy. I adaoted most of the test posts in the theme from WordPress’s theme unit test. [https://codex.wordpress.org/Theme\_Unit\_Test](https://codex.wordpress.org/Theme_Unit_Test)