Site Search

[RassanGrant]

Hey @vleong2332 -

We talked implementing some kind of site search awhile back. I found a couple of Jekyll templates that have implementations - Is it easier to know how to implement this once you have a template?

https://nubia-jekyll.netlify.com/ https://aspirethemes.com/docs/nubia-jekyll/

[vleong2332]

@RassanGrant is this for the blog or the website?

[albertvolkman]

For site search I've been looking at using Lunr.js. There's also a hosted version-

https://www.algolia.com/

[vleong2332]

Those look very promising.

Just in case you weren't aware, @RassanGrant, the search functionality has mainly 2 parts: the UI visible to the user and the behind-the-scene mechanics. The theme you posted uses ghostHunter, which, in turn, uses lunr.js for the behind-the-scene mechanic that @albertvolkman mentioned.

If you like the theme, we could pick that as a starting point. If not, we can still use lunr.js with our own "theme".

Looking over the docs briefly, Integrating lunr.js will include at least the following:

• Build a document of searchable things to be fed into the search functionality. This document would probably need to be a part of the build system so that it gets updated whenever we add/remove things to the site.
• Build a UI for taking search input and showing search results
• Build the actual search functionality that utilizes lunr.js

Any questions so far?