kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

Fix markup and improve Action Text guide a bit [ci skip]

Browse source 
* The last html block wasn't formatting properly, it needed a blank line
  between the paragraph and the text.
* The ordered list wasn't generating the sequence, but always showing 1.,
  the inner content/examples needed to be indented for that to work.
* Mark some pieces as inline code for highlighting.
* Tweak a couple sentences.
This commit is contained in:
Carlos Antonio da Silva 2019-12-31 07:37:09 -03:00
parent 22483b86a6
commit 95eb9cfd3c
1 changed files with 26 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
guides/source/action_text_overview.md
View file

@ -51,25 +51,24 @@ After the installation is complete, a Rails app using Webpacker should have the
1. Both `trix` and `@rails/actiontext` should be required in your JavaScript pack.
```js
// application.js
require("trix")
require("@rails/actiontext")
```
```js
// application.js
require("trix")
require("@rails/actiontext")
```
2. The `trix` stylesheet should be imported into `actiontext.scss`.
```scss
@import "trix/dist/trix";
```
```scss
@import "trix/dist/trix";
```
Additionally, this `actiontext.scss` file should be imported into your stylesheet pack.
```
// application.scss
@import "./actiontext.scss";
```
Additionally, this `actiontext.scss` file should be imported into your stylesheet pack.
```
// application.scss
@import "./actiontext.scss";
```
## Examples
@ -124,19 +123,20 @@ You can also style the HTML used for embedded images and other attachments (know
On installation, Action Text will copy over a partial to
`app/views/active_storage/blobs/_blob.html.erb`, which you can specialize.
## Just backend development (APIs)
## API / Backend development
1. For just APIs development your API needs a separate endpoint for uploading files that creates an ActiveStorage::Blob and returns its attachable_sgid:
1. A backend API (for example, using JSON) needs a separate endpoint for uploading files that creates an `ActiveStorage::Blob` and returns its `attachable_sgid`:
```json
{
"attachable_sgid": "BAh7CEkiCG…"
}
```
```json
{
"attachable_sgid": "BAh7CEkiCG…"
}
```
2. Take that attachable_sgid and ask your frontend to insert it in rich text content using an `<action-text-attachment>` tag:
```html
<action-text-attachment sgid="BAh7CEkiCG…"></action-text-attachment>
```
2. Take that `attachable_sgid` and ask your frontend to insert it in rich text content using an `<action-text-attachment>` tag:
This is based on basecamp so if you still can't find what you are looking for, check [Basecamp Doc](https://github.com/basecamp/bc3-api/blob/master/sections/rich_text.md)
```html
<action-text-attachment sgid="BAh7CEkiCG…"></action-text-attachment>
```
This is based on Basecamp, so if you still can't find what you are looking for, check this [Basecamp Doc](https://github.com/basecamp/bc3-api/blob/master/sections/rich_text.md).