Skip to content
This repository has been archived by the owner on Mar 18, 2019. It is now read-only.

The redactor-rails gem integrates the Redactor editor with the Rails 3.2 asset pipeline.

License

Notifications You must be signed in to change notification settings

kausters/redactor-rails

 
 

Repository files navigation

Rails 4 Integration for Redactor

(Paperclip No-Devise Edition with Bourbon/Compass support and unset editor styles)

The redactor-rails gem integrates the Redactor editor with the Rails asset pipeline.

This gem bundles Redactor version 9.1.9 which is the most recent version as of December 12, 2013. Check Redactor's changelog for further updates.

Installation

Add this line to your application's Gemfile:

gem 'redactor-rails', github: "kausters/redactor-rails"

And then execute:

$ bundle install

Add to application.rb:

require 'redactor-rails'

Now generate models for store uploading files

ActiveRecord + carrierwave

gem "carrierwave"
gem "mini_magick"

$ rails generate redactor:install

$ rake db:migrate

ActiveRecord + paperclip

gem "paperclip"

$ rails generate redactor:install --backend=paperclip

$ rake db:migrate

Mongoid + carrierwave

gem "carrierwave"
gem "carrierwave-mongoid", require: "carrierwave/mongoid"
gem "mini_magick"

$ rails generate redactor:install

Include the Redactor assets

Add to your application.js:

//= require redactor-rails

Add to your application.css.scss:

@import 'redactor-rails';

Initialize Redactor

For each textarea that you want to use with Redactor, add the "redactor" class and ensure it has a unique ID:

<%= text_area_tag :editor, "", class: "redactor", rows: 40, cols: 120 %>

Customize the Redactor editor

If you need change some config in Redactor, you can

$ rails generate redactor:config

Then generate app/assets/redactor-rails/config.js.

See the Redactor Documentation for a full list of configuration options.

If You Want To setup a new language in Redactor you should do two things:

In you file app/assets/redactor-rails/config.js set option

lang: 'lv'

and

Add to your application.js (version >= 0.4)

//= require redactor-rails/langs/lv

or add to your layout

<%= redactor_lang('lv') %>

Contributing

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

Special Thanks

wildjcrt (Jerry Lee)

Statement

redactor-rails part of reference galetahub/ckeditor project.

redactor-rails uses MIT-LICENSE. Rock!!!!!

License

the redactor-rails project is MIT-LICENSE.

You may use Redactor for non-commercial websites for free, however, we do not guarantee any technical support.

Redactor has 3 different licenses for commercial use. For details please see License Agreement.

About

The redactor-rails gem integrates the Redactor editor with the Rails 3.2 asset pipeline.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 96.3%
  • JavaScript 3.7%