rails/actiontext
Jonathan Hefner 4dcd6ba8d3 Update .gitattributes for generated JavaScript [ci-skip]
This adds `linguist-generated` and `linguist-vendored` attributes where
appropriate to suppress the files in diffs and exclude the files from
the project's language stats on GitHub.

See https://github.com/github/linguist for more information.
2023-11-05 15:48:08 -06:00
..
app Update .gitattributes for generated JavaScript [ci-skip] 2023-11-05 15:48:08 -06:00
bin Remove unused webpacker related files 2023-09-08 11:22:09 +00:00
db/migrate Ensure Action Text migration use config set primary_key_type 2021-06-30 23:17:36 +05:30
lib Document Action Text Sanitization 2023-10-30 17:49:13 -04:00
test Add JavascriptPackageTest for Action Text 2023-11-05 15:28:14 -06:00
.gitignore Ignore local .sqlite3 files that are created under storage directory 2022-12-27 11:35:26 +09:00
CHANGELOG.md Fix using trix in sprockets 2023-10-25 00:25:35 -04:00
MIT-LICENSE Remove Copyright years (#47467) 2023-02-23 11:38:16 +01:00
README.md 🔗 Remove RDoc auto-link from Rails module everywhere 2023-06-23 10:49:30 +09:00
Rakefile Use version of importmap that support loading outside of an app 2023-10-27 20:23:42 +00:00
actiontext.gemspec Use `ActiveRecord::FixtureSet.signed_global_id` defined by the globalid gem 2021-11-24 22:34:37 +00:00
package.json Remove webpack as runtime dep of Action Text 2023-10-05 07:50:57 -04:00
rollup.config.js Switch to ESM compatible build of trix 2021-08-13 11:10:05 +02:00

README.md

Action Text

Action Text brings rich text content and editing to \Rails. It includes the Trix editor 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 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.