Skip to content

Commit 4e7d23c

Browse files
authored
Merge pull request #690 from ExpressionEngine/feature/7.x/ckeditor-38
Added RTE configuration to use custom CKEditor build
2 parents e5c2df4 + e77048c commit 4e7d23c

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/add-ons/rte.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ The following are the buttons that can be enabled in tool set to manipulate the
7373
<li>Superscript</li>
7474
<li>Block quote</li>
7575
<li>Code</li>
76+
<li>Code block</li>
7677
<li>Heading / Format</li>
7778
<li>Remove formatting (CKEditor only)</li>
7879
<li>Style (Redactor only)</li>
@@ -95,6 +96,7 @@ The following are the buttons that can be enabled in tool set to manipulate the
9596
<li>"Read More" separator</li>
9697
<li>Font color / background</li>
9798
<li>Fullscreen (Redactor only)</li>
99+
<li>HTML Source editing</li>
98100
</ul>
99101

100102
#### Custom Stylesheet
@@ -148,6 +150,7 @@ To delete a tool set, check the tool set's checkbox in the tool set table listin
148150

149151
- **Default RTE tool set** - select the tool set that will be selected by default when creating a field.
150152
- **File Browser** - select file browser that will be used when browsing for images and files from RTE fields. ExpressionEngine's FilePicker is used by default, third-party add-ons can provide their own filepickers
153+
- **Use custom CKEditor build** - Allows using custom CKEditor build with extra plugins. If enabled, RTE instances running CKEditor will be built using the script in `themes/user/rte/javascript/` folder.
151154

152155
NOTE: **Note:** If using the [Multiple Site Manager](msm/overview.md), this preference is per-site.
153156

@@ -170,7 +173,9 @@ NOTE: **Warning** Doing this requires advanced development skills.
170173
In order to create custom CKEditor build:
171174
- Clone [GitHub repo](https://github.com/ExpressionEngine/ExpressionEngine/)
172175
- Install NPM packages by running `npm install`
173-
- Follow the installation instructions for the plugin itself
174-
- Make your changes to `js-src\ckeditor5-build-classic\src\ckeditor.js` and other files as necessary.
176+
- Follow the installation instructions for the extra CKEditor plugins that you need
177+
- Make your changes to `js-src/ckeditor5-build-classic/src/ckeditor.js` and other files as necessary.
175178
- Run the command `npm run build:ckeditor`
176-
- Copy the files from `themes/ee/asset/javascript/src/fields/rte/ckeditor` to same folder on your EE installation
179+
- Copy the files from `themes/ee/asset/javascript/src/fields/rte/ckeditor` to `themes/user/rte/javascript/` folder on your EE installation
180+
181+
TIP: Buttons provided by extra plugins might be not availble with visual toolbar builder. You will need to use Advanced Configuration JSON file to add those.

0 commit comments

Comments
 (0)