Skip to content

dnoneill/jekyll-lunr-js-custom-search

 
 

Repository files navigation

Custom search for Jekyll websites using lunr.js

Originally forked from jekyll-lunr-js-search and refactored for advanced or query search with customization for collections. This will also work with posts because they are classified as the collection 'posts'.

Using gem

Quickstart instructions are located here: https://dnoneill.github.io/jekyll-lunr-js-custom-search/quickstart

Demo

There is a demo of this gem running: https://dnoneill.github.io/jekyll-lunr-js-custom-search/demo The Jekyll code for the demo is located here: https://github.com/dnoneill/jekyll-lunr-js-custom-search/tree/gh-pages/demo

Development Requirements

Install Bundler and then run the following.

bundle install

Install Bower.

To build the plugin.

rake build

Then copy build/jekyll_lunr_js_search.rb to your Jekyll site's _plugins folder and the build/*.min.js files to your site's js folder.

If you include the .js and .js.map files your browser developer console will link to the unminified code.