/jekyll-search-system

This project provides your static website a lightning fast search engine.

Primary LanguageJavaScriptMIT LicenseMIT

Jekyll Search System

Searching on a static website? Yep, it can be done easily. The only things you need is a static database and a searching algorithm. This description describes the necessary steps to create a lightning fast good looking search system for your Jekyll based site. The method is also compatible with GitHubPages.

Installation

  1. Copy jekyll-search.js or jekyll-search.min.js to your scripts folder.
  2. Include the copied script like I do in the template.html file.
  3. Add the html skeleton to your page anywhere you want the search field to appear.
  4. Copy the provided CSS rules if you want the exact same look otherwise create your own rules based on the provided ones.
  5. Copy the search.json file to your root folder of your site, and change it according to your needs.

Congratulations, you have just created a custom search system for your Jekyll site.

License

This project is under the MIT license. See the included license file for further details.