Simple Jekyll Search screenshot

Simple Jekyll Search

Author Avatar Theme by Christian fei
Updated: 27 Aug 2021
1347 Stars

A JavaScript library to add search functionality to any Jekyll blog.

Categories

Overview

Simple-Jekyll-Search is a JavaScript library that allows you to add search functionality to any Jekyll blog. It is a lightweight solution that does not require server configurations or databases to maintain. With just a few minutes of setup, you can have a fully working searchable blog.

Features

  • Lightweight search functionality for Jekyll blogs
  • Purely client-side, no server configurations or databases required
  • Quick and easy installation process
  • Can be customized to fit your specific needs
  • Supports filtering posts by tags or categories
  • Provides options for sorting and limiting the search results
  • Enables fuzzy search for less restrictive matching

Installation

To install Simple-Jekyll-Search, follow these steps:

  1. Install npm.
  2. Create a file called search.json in the root directory of your Jekyll blog. You can use the provided code or obtain a copy from the given source.
  3. Add the necessary DOM elements to your Jekyll layout: a search input field and a result container.
  4. Place the provided code within the layout where you want the search to appear.
  5. Customize the configuration options according to your preferences.

Summary

Simple-Jekyll-Search is a JavaScript library that provides a lightweight and client-side search functionality for Jekyll blogs. It eliminates the need for server configurations or databases, making it a quick and easy solution to implement. The library can be customized to fit your specific needs and supports features such as filtering, sorting, and limiting search results. With Simple-Jekyll-Search, you can have a fully working searchable blog in just a few minutes.