dcs-notes.github.io icon indicating copy to clipboard operation
dcs-notes.github.io copied to clipboard

Added Algolia's Jekyll plugin to build a search index

Open tomasff opened this issue 3 years ago • 5 comments

I've added Algolia's Jekyll plugin so that we could search through the entire notes posted on the website.

I've tested this in a fork of csrgg-home and it would look like this: UI

I modified the current GH Actions to update the index when the site is built too, although I haven't been able to test the changes.

You'd need to setup an index in Algolia to get an API key and the other credentials. They have a free plan that should be enough (10k search results/month). We might be able to get more search results per month using Algolia for Open Source

This is related to this PR.

tomasff avatar May 19 '21 18:05 tomasff

Oh also there's a demo of the searching thing here. It's also possible to add the search bar directly on the current home page.

tomasff avatar May 19 '21 20:05 tomasff

Looks really good to me, we'll discuss about it abit and decide if we want to go with it.

For now, I've changed the base branch from master to a new one. If we go through with it we'll add the API Keys and test it before pushing it to master.

Justanhy avatar May 20 '21 08:05 Justanhy

I've added Algolia's Jekyll plugin so that we could search through the entire notes posted on the website.

I've tested this in a fork of csrgg-home and it would look like this:

UI

I modified the current GH Actions to update the index when the site is built too, although I haven't been able to test the changes.

You'd need to setup an index in Algolia to get an API key and the other credentials. They have a free plan that should be enough (10k search results/month). We might be able to get more search results per month using Algolia for Open Source

This is related to this PR.

Thank you a lot for integrating this, Tomas! I'll look into Algolia for Open Source and work with @Justanhy to get those keys set up. Reading on their site, I don't think we'll qualify for AOS, but it won't hurt to apply and see what they say.

leoriviera avatar May 21 '21 21:05 leoriviera

@all-contributors add @tomasff to design

EdmundGoodman avatar May 22 '21 19:05 EdmundGoodman

@EdmundGoodman

I've put up a pull request to add @tomasff! :tada:

allcontributors[bot] avatar May 22 '21 19:05 allcontributors[bot]