No description, website, or topics provided.
Clone or download
Latest commit 912ffe7 Dec 17, 2017

README.md

Trix

Build Status

Want to include Basecamp's awesome Trix WYSIWYG editor in your Ruby on Rails application? You've come to the right place!

Please see the appropriate guide for your environment of choice:

a. Ruby on Rails

trix is easy to drop into Rails with the asset pipeline.

In your Gemfile you need to add the trix gem.

gem 'trix'

bundle install and restart your server to make the files available through the pipeline.

Import Trix styles in app/assets/stylesheets/application.css:

*= require trix

Require Trix Javascript magic in app/assets/javascripts/application.js:

//= require trix

Finally, any place where you would like to use the Trix editor in your forms, just use the trix_editor helper:

f.trix_editor :body

If you are using the Formtastic gem or the Simple Form gem, you can do this:

f.input :body, as: :trix_editor

Trix

For the official Trix Github repository, go here.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/maclover7/trix.

Upgrading Trix

  1. Copy and paste Trix's trix.js to vendor/assets/javascripts/trix.js
  2. Copy and paste Trix's trix.css to vendor/assets/stylesheets/trix.css
  3. Update lib/trix/version.rb with the correct version number
  4. git commit -am 'Bump to vVERSION'
  5. bundle exec rake release

License

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