Giter Site home page Giter Site logo

super-search's Introduction

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:

Demo

Visit my website and press '/' key.

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

Screenshot

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 <head> tag.

Usage

Add markup for your search UI:

<div class="super-search" id="js-super-search">
	<a href="javascript:void(0)" onclick="superSearch.toggle()" class="super-search__close-btn">X</a>
	<input type="text" placeholder="Type here to search" class="super-search__input" id="js-super-search__input">
	<ul class="super-search__results" id="js-super-search__results"></ul>
</div>

And initialize superSearch as follows with optional parameters:

superSearch({
	searchFile: '/feed.xml',
	searchSelector: '#js-super-search', // CSS Selector for search container element.
	inputSelector: '#js-super-search__input', // CSS selector for <input>
	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.

super-search's People

Contributors

chinchang avatar flamefractal avatar lostwarrior404 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.