rails--rails/actiontext/README.md

# Action Text

Action Text brings rich text content and editing to Rails. It includes the [Trix editor](https://trix-editor.org) that handles everything from formatting to links to quotes to lists to embedded images and galleries. The rich text content generated by the Trix editor is saved in its own RichText model that's associated with any existing Active Record model in the application. Any embedded images (or other attachments) are automatically stored using Active Storage and associated with the included RichText model.

You can read more about Action Text in the [Action Text Overview](https://edgeguides.rubyonrails.org/action_text_overview.html) guide.

## Development

The JavaScript for Action Text is distributed both as a npm module under @rails/actiontext and via the asset pipeline as actiontext.js (and we mirror Trix as trix.js). To ensure that the latter remains in sync, you must run `yarn build` and checkin the artifacts whenever the JavaScript source or the Trix dependency is bumped. CSS changes must be brought over manually to app/assets/stylesheets/trix.css

## License

Action Text is released under the [MIT License](https://opensource.org/licenses/MIT).
Import Action Text 2019-01-04 19:43:11 -05:00			`# Action Text`

Add Action Text to guides [ci skip] - Move some actiontext/README.md content to Action Text Overview guide - I added WIP label to that guide since we definitely want to complement it. - Add Action Text to Major Features of Rails 6.0 Similar approach was used in #34812 2019-01-05 06:20:02 -05:00			Action Text brings rich text content and editing to Rails. It includes the [Trix editor](https://trix-editor.org) that handles everything from formatting to links to quotes to lists to embedded images and galleries. The rich text content generated by the Trix editor is saved in its own RichText model that's associated with any existing Active Record model in the application. Any embedded images (or other attachments) are automatically stored using Active Storage and associated with the included RichText model.
Import Action Text 2019-01-04 19:43:11 -05:00
Add Action Text to guides [ci skip] - Move some actiontext/README.md content to Action Text Overview guide - I added WIP label to that guide since we definitely want to complement it. - Add Action Text to Major Features of Rails 6.0 Similar approach was used in #34812 2019-01-05 06:20:02 -05:00			`You can read more about Action Text in the [Action Text Overview](https://edgeguides.rubyonrails.org/action_text_overview.html) guide.`
Import Action Text 2019-01-04 19:43:11 -05:00
Make Action Text + Trix JS/CSS available via the asset pipeline (#42857) * Action Text JS should be available via the asset pipeline too * Main was a module anyway, no need to reference that twice * Fix rollup references * Precompile action text JS for asset pipeline * No JavaScript dependencies needed with the asset pipeline * Stub Webpacker::Engine to trigger webpack path for testing * Extract asset paths * Exercise asset pipeline path * Terser doesn't do anything useful on this small package * Make trix directly available to the asset pipeline * Indirect doesn't carry its worth * Reminder for development about keeping things in sync for the asset pipeline * Ensure this isn't turned into undefined while mirroring * Mirror Trix CSS for asset pipeline * Add the needed JS include tag automatically under the asset pipeline * Please RuboCop * Keep the peer dependency Even though we also need it explicitly as a dev dependency in order to generate the mirror output for trix. * Fix test * Add CHANGELOG entry 2021-07-26 18:57:42 -04:00			`## Development`

No underscore style (#42898) Just like activestorage.js 2021-07-28 15:34:59 -04:00			The JavaScript for Action Text is distributed both as a npm module under @rails/actiontext and via the asset pipeline as actiontext.js (and we mirror Trix as trix.js). To ensure that the latter remains in sync, you must run `yarn build` and checkin the artifacts whenever the JavaScript source or the Trix dependency is bumped. CSS changes must be brought over manually to app/assets/stylesheets/trix.css
Make Action Text + Trix JS/CSS available via the asset pipeline (#42857) * Action Text JS should be available via the asset pipeline too * Main was a module anyway, no need to reference that twice * Fix rollup references * Precompile action text JS for asset pipeline * No JavaScript dependencies needed with the asset pipeline * Stub Webpacker::Engine to trigger webpack path for testing * Extract asset paths * Exercise asset pipeline path * Terser doesn't do anything useful on this small package * Make trix directly available to the asset pipeline * Indirect doesn't carry its worth * Reminder for development about keeping things in sync for the asset pipeline * Ensure this isn't turned into undefined while mirroring * Mirror Trix CSS for asset pipeline * Add the needed JS include tag automatically under the asset pipeline * Please RuboCop * Keep the peer dependency Even though we also need it explicitly as a dev dependency in order to generate the mirror output for trix. * Fix test * Add CHANGELOG entry 2021-07-26 18:57:42 -04:00
Import Action Text 2019-01-04 19:43:11 -05:00			`## License`

			`Action Text is released under the [MIT License](https://opensource.org/licenses/MIT).`