trix

0
0
0
Ruby
public
Forked
Archived

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

Or if you are using the formtastic gem:

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. Update vendor/assets/stylesheets/trix.css and
    vendor/assets/javascripts/trix.js.
  2. Push a new version up to Rubygems.org, make sure the version number
    matches that of Trix itself!

License

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

v0.3.3[beta]