Skip to content

Latest commit

 

History

History
executable file
·
85 lines (50 loc) · 3.26 KB

README.md

File metadata and controls

executable file
·
85 lines (50 loc) · 3.26 KB

Simple-Jekyll-Search

No additional gems required.

Works out of the box.

Fast, lightweight, super easy to set up and fully customizable with CSS!

#####v2

Version 2 comes with improved search and templating engine!

#####v3

But what if I don't want jQuery? No problem, I got you covered. jekyll-search.js is what you've been looking for on the second page of Google search results.

##How to

First of all include the script

<script src="js/jekyll-search.js"></script>

This will create a global object called JekyllSearch, on which you can invoke the init() function.

#Customize the plugin

If you want, you can customize several options of this plugin:

  • searchInput (Element) the input field to listen on
  • searchResults (Element) the container to which JekyllSearch will write the matched search results
  • jsonFile (String) location of the JSON file, our little "database"
  • template (String) template (Mustache-like)
  • searchResultsHeader (String) Heading of the search results
  • limit (Integer) Limit the search results to a sane amount (10-15)
  • fuzzy (Boolean) Turn on/off fuzzy search
  • noResults (String) Text to display if nothing matched the search criteria

You can pass the customized properties into an object when you invoke the init function, like this:

Let's say I want to apply JekyllSearch to a non-default input field (.search), e.g. #search-this-page.

I also changed the location of the JSON file, which is now site-search.json and I have a different template.

Plus I want to turn on fuzzy search:

JekyllSearch.init({
	searchInput: document.getElementById("search-this-page"),
	jsonFile: "site-search.json",
	template: "<a href='{url}' title='{title}'>{title} <span class='tooltip'>{description}</span></a>",
	fuzzy: true
});

Template

Fuzzy search

####Special thanks

These people helped with suggestions, improvements and bug reports to make this plugin better :

#License ##MIT licensed Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.