https://github.com/alexwebgr/aw-trix_rails
A gem that wraps trix editor for Rails assets pipeline
https://github.com/alexwebgr/aw-trix_rails
gem rich-text-editor ruby-on-rails trix trix-editor
Last synced: about 1 month ago
JSON representation
A gem that wraps trix editor for Rails assets pipeline
- Host: GitHub
- URL: https://github.com/alexwebgr/aw-trix_rails
- Owner: alexwebgr
- License: mit
- Created: 2019-03-23T13:22:57.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-26T19:12:00.000Z (about 7 years ago)
- Last Synced: 2025-12-14T03:34:11.355Z (6 months ago)
- Topics: gem, rich-text-editor, ruby-on-rails, trix, trix-editor
- Language: Ruby
- Size: 57.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Aw::TrixRails
A gem for the Ruby on Rails assets pipeline. The gem version matches the one of the editor.
[](https://badge.fury.io/rb/aw-trix_rails)
## Installation
Add this line to your application's Gemfile:
```ruby
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](https://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](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## 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](https://github.com/[USERNAME]/aw-trix_rails/blob/master/CODE_OF_CONDUCT.md).