Jekyll search

March 13, 2015 ยท View on GitHub

Basic Jekyll setup with search via JSON.

Version history

Version no.DescriptionDate
0.3Support for collections13 March 2014
0.2.1Used built-in jsonify filter (thanks to davekinkead)25 September 2014
0.2Used built-in ruby JSON (thanks to mrvdb)20th May 2014
0.1First draft24th February 2014

Usage

Use on an existing Jekyll installation (http://jekyllrb.com/)

  • Place _plugins, feeds, search and scripts directories in root of jekyll installation
  • Add url: http://example.com to _config.yml

Omissions

  • To omit a page or post from search add search_omit: true to YAML Front Matter

Notes

  • To run locally use local domain as url in _config.yml e.g. url: http://localhost:4000
  • jQuery library is included in /search/index.html - Remove if not needed, or move to <head> if preferred