dcs-notes.github.io
dcs-notes.github.io copied to clipboard
Added Algolia's Jekyll plugin to build a search index
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:
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.
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.
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.
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:
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.
@all-contributors add @tomasff to design