oskarer/featherlight-rails

Featherlight.js as a Ruby gem

Featherlight.js

The lightweight and easy to use lightbox jQuery plugin Featherlight, as a ruby gem. Current version is 1.3.5, see the official website for more info.

Installation

Add this line to your application's Gemfile:

gem 'featherlight'

And then execute:

$ bundle

Or install it yourself as:

$ gem install featherlight

Usage

This just adds the required JavaScript and CSS files to your Rails project, see the official website for usage instructions.

For using in your Rails project, include the featherlight in your application.js after including jQuery

//= require jquery
//= require featherlight
//= require featherlight-gallery

Also include the css in application.css

 *= require featherlight
 *= require featherlight-gallery

NOTE: Including featherlight-gallery is only needed if you want the gallery functionality.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request