Skip to content

A gem that wraps trix editor for Rails assets pipeline

License

Notifications You must be signed in to change notification settings

alexwebgr/aw-trix_rails

Repository files navigation

Aw::TrixRails

A gem for the Ruby on Rails assets pipeline. The gem version matches the one of the editor.

Gem Version

Installation

Add this line to your application's Gemfile:

gem 'aw-trix_rails'

And then execute:

$ bundle

Or install it yourself as:

$ gem install aw-trix_rails

Usage

Just include the .js and .css files in the application.js

//= require trix

and application.scss

@import "trix";

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/alexwebgr/aw-trix_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

Code of Conduct

Everyone interacting in the Aw::TrixRails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.