Skip to content

Commit

Permalink
Document ckeditor/convert/matrix
Browse files Browse the repository at this point in the history
  • Loading branch information
brandonkelly committed Aug 15, 2024
1 parent db4e13f commit f3cfb0b
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,12 +290,22 @@ This example treats both chunk types as strings. For entry chunks, this is equiv

## Converting Redactor Fields

You can use the `ckeditor/convert` command to convert any existing Redactor fields over to CKEditor. For each unique Redactor config, a new CKEditor config will be created and associated with the appropriate field(s).
You can use the `ckeditor/convert/redactor` command to convert any existing Redactor fields over to CKEditor. For each unique Redactor config, a new CKEditor config will be created and associated with the appropriate field(s).

```sh
php craft ckeditor/convert
php craft ckeditor/convert/redactor
```

## Converting Matrix Fields

You can use the `ckeditor/convert/matrix` command to convert a Matrix field over to CKEditor. Each of the Matrix field’s entry types will be assigned to the CKEditor field, and field values will be a mix of HTML content extracted from one of the nested entry types of your choosing (if desired) combined with nested entries.

```sh
php craft ckeditor/convert/matrix <myMatrixFieldHandle>
```

The command will generate a new content migration, which will need to be run on other environments (via `craft up`) in order to update existing elements’ field values.

## Adding CKEditor Plugins

Craft CMS plugins can register additional CKEditor plugins to extend its functionality.
Expand Down

0 comments on commit f3cfb0b

Please sign in to comment.