https://github.com/chinchang/super-search

Easy to add search for your blog
https://github.com/chinchang/super-search

Last synced: about 1 month ago
JSON representation

Easy to add search for your blog

• Host: GitHub
• URL: https://github.com/chinchang/super-search
• Owner: chinchang
• Created: 2015-06-07T14:28:29.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-10-14T17:34:17.000Z (almost 8 years ago)
• Last Synced: 2024-07-24T22:44:04.892Z (about 2 months ago)
• Language: JavaScript
• Homepage: https://kushagragour.in/
• Size: 52.7 KB
• Stars: 79
• Watchers: 5
• Forks: 13
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
super-search

=====

*Easy to add search for your blog*

***

`super-search` adds search feature to your blog. `super-search` works on your blog's RSS feeds to enable searching posts.

I created this plugin to be used with a Jekyll blog. But it will work equally good with any blog having an RSS feed file. If you do not have one already, here are some easy ways to do it for your blog:

- [RSS for Jekyll blog](http://joelglovier.com/writing/rss-for-jekyll).

Demo

-----

[Visit my website](http://kushagragour.in/) and press '/' key.

Or Checkout the `example.html` file in this repo. Remember to run it on http/https protocol.

![Screenshot](/screenshot1.png)

Installation

-----

Add `super-search.js` at the end of your blog HTML.

If you want readymade styling for the search also, add `super-search.css` inside your blog's `` tag.

Usage

-----

Add markup for your search UI:

```html



	X

	

	




```


And initialize `superSearch` as follows with optional parameters:

```js

superSearch({

	searchFile: '/feed.xml',

	searchSelector: '#js-super-search', // CSS Selector for search container element.

	inputSelector: '#js-super-search__input', // CSS selector for 

	resultsSelector: '#js-super-search__results' // CSS selector for results container

});

```

Browser Support

-----

**super-search** works best on latest versions of Google Chrome, Firefox and Safari.

License

-----

Copyright (c) 2015 Kushagra Gour, http://kushagragour.in

Licensed under the [MIT license](http://opensource.org/licenses/MIT).