Get Raptor Editor into your Rails apps
Pull request Compare This branch is 30 commits behind PANmedia:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
vendor/assets/javascripts
.gitignore
Gemfile
Gemfile.lock
MIT-LICENSE
README.md
Rakefile
raptor-editor-rails.gemspec

README.md

raptor-editor-rails

The simplest way to get Raptor Editor onto the Asset Pipeline in your Rails applications.

Version

Version 0.187 contains Raptor Editor 0.0.30-beta.

Requirements

Usage

raptor-editor-rails provides two Raptor Editor packages:

  • raptor.min.js is Raptor Editor on its own
  • raptor.light.min.js is Raptor Editor and Rangy

If, by some chance, you are already using Rangy then use raptor.min. Otherwise, use raptor.light.min.

Add raptor-editor-rails to your Gemfile:

gem "raptor-editor-rails"

and then

bundle install

Add Raptor Editor to your app/assets/javascripts/application.js after jQuery and jQuery UI:

//= require jquery
//= require jquery-ui
//= require raptor.light.min # or raptor.min.js if you already have Rangy

You can now make elements of your site editable using:

$("#my_editable_element").editor();

See the Raptor Editor documentation for more information.

Bugs, Issues and Feature Requests

Please raise an issue on GitHub.

Licence

This Gem, jquery-raptor-rails, is distributed under the MIT License.

Raptor Editor is distributed under GPL.

Contributing

  1. Fork,
  2. Hack,
  3. Create a Pull Request.

Getting the latest version of Raptor Editor

  1. Find the latest version number from the latest release's tag name at https://github.com/PANmedia/Raptor/tags,
  2. Update RAPTOR_EDITOR_VERSION in lib/raptor_editor_rails/version.rb (don't include the "v" in the tag name),
  3. Run rake fetch to automatically download the correct files,
  4. Update README.md with the latest version number.