0.0
No commit activity in last 3 years
No release in over 3 years
rails_shepherd wraps the Shepherd JavaScript library so that it can easily be included in Rails.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.3, >= 2.3.11
 Project Readme

Gem Version

RailsShepherd

This gem wraps the Shepherd JavaScript library so that it can be included easily in the Rails asset pipeline.

Actual Shepherd Version: 34.6.0

Installation

Add this line to your application's Gemfile:

gem 'rails_shepherd'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rails_shepherd

Usage

add rails_shepherd to your application.js manifest

//= require popper.js
//= require tippy.js
//= require shepherd.min.js

and include the stylesheets in your application.css manifest

This gem includes the CSS for shepherd-theme-default, shepherd-theme-square, and shepherd-theme-dark... You can include whichever files you need in your application.css with

*= require shepherd-theme-default
*= require shepherd-theme-square
*= require shepherd-theme-dark

Contributing

If you need a newer version of Shepherd:

  1. Fork this repo.
  2. Update the vendored files with the newest release of Shepherd
  3. Update lib/rails_shepherd/version.rb to match the version of Shepherd that you updated to.
  4. Push to your repo and create a pull request.

License

The gem is available as open source under the terms of the MIT License.