You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ A set of ready-to-use rich text editors created with a powerful framework. Made
17
17
## Table of contents
18
18
19
19
*[Quick start](#quick-start)
20
-
*[CKEditor 5 Builds](#ckeditor-5-builds)
20
+
*[CKEditor 5 builds](#ckeditor-5-builds)
21
21
*[CKEditor 5 Framework](#ckeditor-5-framework)
22
22
*[Documentation and FAQ](#documentation-and-faq)
23
23
*[Contributing and project organization](#contributing-and-project-organization)
@@ -35,11 +35,11 @@ A set of ready-to-use rich text editors created with a powerful framework. Made
35
35
36
36
## Quick start
37
37
38
-
### CKEditor 5 Builds
38
+
### CKEditor 5 builds
39
39
40
-
CKEditor 5 Builds are a set of ready-to-use rich text editors. Every "build" provides a single type of editor with a set of features and a default configuration.
40
+
CKEditor 5 builds are a set of ready-to-use rich text editors. Every "build" provides a single type of editor with a set of features and a default configuration.
41
41
42
-
The following CKEditor 5 Builds are currently available:
42
+
The following CKEditor 5 builds are currently available:
@@ -84,7 +84,7 @@ To find out how to start with other builds check the [Quick start guide in the C
84
84
85
85
### CKEditor 5 Framework
86
86
87
-
CKEditor 5 Builds allow you to quickly and easily initialize one of the many types of editors in your application. At the same time, CKEditor 5 is also a framework for creating custom-made rich text editing solutions.
87
+
CKEditor 5 builds allow you to quickly and easily initialize one of the many types of editors in your application. At the same time, CKEditor 5 is also a framework for creating custom-made rich text editing solutions.
88
88
89
89
To find out how to start building your own editor from scratch go to [CKEditor 5 Framework overview section of CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/overview.html).
90
90
@@ -94,7 +94,7 @@ To find out more see the following [CKEditor 5 documentation](https://ckeditor.c
Copy file name to clipboardexpand all lines: docs/api/index.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -18,8 +18,8 @@ category: api-reference
18
18
## Documentation
19
19
20
20
* {@link framework/index CKEditor 5 Framework} – Learn how to develop with CKEditor 5 Framework, customize it and create plugins.
21
-
* {@link builds/guides/overview CKEditor 5 Builds} – Learn how to install, integrate and configure CKEditor 5 Builds. More complex aspects, like creating custom builds, are explained here, too.
22
-
* {@link features/index Features} – Learn about some of the features included in CKEditor 5 Builds.
21
+
* {@link builds/guides/overview CKEditor 5 builds} – Learn how to install, integrate and configure CKEditor 5 builds. More complex aspects, like creating custom builds, are explained here, too.
22
+
* {@link features/index Features} – Learn about some of the features included in CKEditor 5 builds.
Copy file name to clipboardexpand all lines: docs/builds/guides/integration/advanced-setup.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -381,7 +381,7 @@ Webpack 4 introduced the [concept of modes](https://webpack.js.org/concepts/mode
381
381
<info-box>
382
382
Prior to version 1.2.7 `uglifyjs-webpack-plugin` had a bug which caused webpack to crash with the following error: `TypeError: Assignment to constant variable.`. If you experienced this error, make sure that your `node_modules` contains an up-to-date version of this package (and that webpack uses this version).
383
383
384
-
CKEditor 5 Builds use [`Terser`](https://github.com/terser/terser) instead of `uglifyjs-webpack-plugin` because [the later one seems to be unsupported anymore](https://github.com/ckeditor/ckeditor5/issues/1353).
384
+
CKEditor 5 builds use [`Terser`](https://github.com/terser/terser) instead of `uglifyjs-webpack-plugin` because [the later one seems to be unsupported anymore](https://github.com/ckeditor/ckeditor5/issues/1353).
385
385
</info-box>
386
386
387
387
### Option: Extracting CSS
@@ -441,7 +441,7 @@ Webpack will now create a separate file called `styles.css` which you will need
441
441
442
442
### Option: Building to ES5 target
443
443
444
-
CKEditor 5 is written in ECMAScript 2015 (also called ES6). All browsers in which CKEditor 5 is {@link builds/guides/support/browser-compatibility currently supported} have sufficient ES6 support to run CKEditor 5. Thanks to that, CKEditor 5 Builds are also published in the original ES6 format.
444
+
CKEditor 5 is written in ECMAScript 2015 (also called ES6). All browsers in which CKEditor 5 is {@link builds/guides/support/browser-compatibility currently supported} have sufficient ES6 support to run CKEditor 5. Thanks to that, CKEditor 5 builds are also published in the original ES6 format.
445
445
446
446
However, it may happen that your environment requires ES5. For instance, if you use tools like the original [UglifyJS](https://github.com/mishoo/UglifyJS) which do not support ES6+ yet, you may need to transpile CKEditor 5 source to ES5. This will create ~80% bigger builds but will ensure that your environment can process CKEditor 5 code.
Copy file name to clipboardexpand all lines: docs/builds/guides/migration/migration-from-ckeditor-4.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ When compared to its predecessor, CKEditor 5 should be considered **a totally ne
15
15
16
16
There is no "drop in" solution for migrating. In this guide we hope to summarize the most important aspects you need to consider before you proceed with installing CKEditor 5.
17
17
18
-
Before starting, be sure that migrating is your best choice. Refer to {@link builds/guides/overview#when-not-to-use-builds When NOT to use CKEditor 5 Builds?} for more information.
18
+
Before starting, be sure that migrating is your best choice. Refer to {@link builds/guides/overview#when-not-to-use-builds When NOT to use CKEditor 5 builds?} for more information.
Copy file name to clipboardexpand all lines: docs/builds/guides/overview.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -11,11 +11,11 @@ order: 10
11
11
12
12
# Overview
13
13
14
-
Predefined CKEditor 5 Builds are a set of ready-to-use rich text editors. Every "build" provides a single type of editor with a set of features and a default configuration. They provide convenient solutions that can be installed with no effort and that satisfy the most common editing use cases.
14
+
Predefined CKEditor 5 builds are a set of ready-to-use rich text editors. Every "build" provides a single type of editor with a set of features and a default configuration. They provide convenient solutions that can be installed with no effort and that satisfy the most common editing use cases.
15
15
16
16
## Available builds
17
17
18
-
The following CKEditor 5 Builds are currently available:
18
+
The following CKEditor 5 builds are currently available:
Copy file name to clipboardexpand all lines: docs/builds/guides/support/license-and-legal.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ order: 20
8
8
9
9
# License and legal
10
10
11
-
The following legal notices apply to CKEditor 5 Builds and all software from CKEditor 5 Ecosystem included with it.
11
+
The following legal notices apply to CKEditor 5 builds and all software from CKEditor 5 Ecosystem included with it.
12
12
13
13
Copyright (c) 2003-2021, CKSource Frederico Knabben. All rights reserved.
14
14
@@ -20,7 +20,7 @@ If you are running a project with an OSS license incompatible with GPL, please [
20
20
21
21
## Sources of intellectual property included in CKEditor
22
22
23
-
Where not otherwise indicated, all CKEditor 5 Builds content is authored by CKSource engineers and consists of CKSource-owned intellectual property. In some specific instances, CKEditor will incorporate work done by developers outside of CKSource with their express permission.
23
+
Where not otherwise indicated, all CKEditor 5 builds content is authored by CKSource engineers and consists of CKSource-owned intellectual property. In some specific instances, CKEditor will incorporate work done by developers outside of CKSource with their express permission.
Copy file name to clipboardexpand all lines: docs/examples/index.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,6 @@ meta-description: Navigate through CKEditor 5 examples to see what you are able
15
15
16
16
## Related links
17
17
18
-
* {@link features/index Features} – Learn about some of the features included in CKEditor 5 Builds.
19
-
* {@link builds/guides/overview CKEditor 5 Builds} – Learn how to install, integrate and configure CKEditor 5 Builds. More complex aspects, like creating custom builds, are explained here, too.</dd>
18
+
* {@link features/index Features} – Learn about some of the features included in CKEditor 5 builds.
19
+
* {@link builds/guides/overview CKEditor 5 builds} – Learn how to install, integrate and configure CKEditor 5 builds. More complex aspects, like creating custom builds, are explained here, too.</dd>
20
20
* {@link framework/guides/overview CKEditor 5 Framework} – Learn how to work with CKEditor 5 Framework, customize it, create your own plugins, custom editors, how to change the UI or even bring your own UI to the editor.
Copy file name to clipboardexpand all lines: docs/features/index.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -96,7 +96,7 @@ If you want to migrate from CKEditor 4 to CKEditor 5, please check the {@link bu
96
96
97
97
## Feature availability
98
98
99
-
Plenty of these features are included by default in the predefined {@link builds/guides/overview CKEditor 5 Builds} and are available out-of-the-box, like {@link features/autoformat autoformatting} or {@link features/keyboard-support keyboard support}.
99
+
Plenty of these features are included by default in the predefined {@link builds/guides/overview CKEditor 5 builds} and are available out-of-the-box, like {@link features/autoformat autoformatting} or {@link features/keyboard-support keyboard support}.
100
100
101
101
However, some of the presented features need to be manually included in a customized CKEditor 5 build, for example the {@link features/markdown Markdown processor} which outputs Markdown instead of HTML. These plugins can also be easily and conveniently added to a custom build with the [CKEditor 5 online builder](https://ckeditor.com/ckeditor-5/online-builder/).
Copy file name to clipboardexpand all lines: docs/framework/guides/overview.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -5,13 +5,13 @@ order: 10
5
5
6
6
# Overview
7
7
8
-
CKEditor 5 is a project that allows you to quickly and easily initialize one of the many types of editors it offers in your application. At the same time, it is a framework for creating custom-tailored rich-text editing solutions. The former requirement is met thanks to {@link builds/guides/overview CKEditor 5 Builds}. The latter — thanks to CKEditor 5 Framework.
8
+
CKEditor 5 is a project that allows you to quickly and easily initialize one of the many types of editors it offers in your application. At the same time, it is a framework for creating custom-tailored rich-text editing solutions. The former requirement is met thanks to {@link builds/guides/overview CKEditor 5 builds}. The latter — thanks to CKEditor 5 Framework.
9
9
10
10
This guide explains how the framework is built and how to start using it.
11
11
12
12
## When to use the framework?
13
13
14
-
{@link builds/guides/development/custom-builds CKEditor 5 Builds can be customized}, but certain types of customizations require using the framework.
14
+
{@link builds/guides/development/custom-builds CKEditor 5 builds can be customized}, but certain types of customizations require using the framework.
15
15
16
16
***Writing your own features.** Features are implemented using the framework.
17
17
***Customizing existing features.** Changing the behavior or look of existing features can be done using the framework capabilities.
@@ -47,7 +47,7 @@ There are a few groups of packages:
47
47
*[Editors](https://github.com/ckeditor/ckeditor5#editors)– Packages that implement various types of editors.
48
48
*[Features](https://github.com/ckeditor/ckeditor5#features)– Packages that implement end user features.
49
49
*[Themes](https://github.com/ckeditor/ckeditor5#themes)– Packages that implement editor themes.
Copy file name to clipboardexpand all lines: docs/framework/guides/quick-start.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ The CKEditor 5 Framework is made of several [npm packages](https://npmjs.com). T
14
14
*[Node.js](https://nodejs.org/en/) 12.0.0+
15
15
* npm 5.7.1+ (**note:** some npm 5+ versions were known to cause [problems](https://github.com/npm/npm/issues/16991), especially with deduplicating packages; upgrade npm when in doubt)
16
16
17
-
Besides Node.js and npm you also need [webpack@4](https://webpack.js.org) with a few additional packages to use the framework. They are needed to bundle the source code. Read more about building CKEditor 5 in the {@link builds/guides/integration/advanced-setup CKEditor 5 Builds Advanced setup} guide.
17
+
Besides Node.js and npm you also need [webpack@4](https://webpack.js.org) with a few additional packages to use the framework. They are needed to bundle the source code. Read more about building CKEditor 5 in the {@link builds/guides/integration/advanced-setup CKEditor 5 builds Advanced setup} guide.
18
18
19
19
<!-- TODO replace the link above when the Framework will get its own building guide. -->
20
20
@@ -172,8 +172,8 @@ npm adds `./node_modules/.bin/` to the `PATH` automatically, so in this case you
172
172
Use `webpack --mode production` if you want to build a minified and optimized application. See more in the [webpack documentation](https://webpack.js.org/concepts/mode/).
173
173
174
174
**Note:** Prior to version 1.2.7, `uglifyjs-webpack-plugin` (the default minifier used by webpack) had a bug which caused webpack to crash with the following error: `TypeError: Assignment to constant variable.`. If you experienced this error, make sure that your `node_modules` contains an up-to-date version of this package (and that webpack uses this version).
175
-
176
-
**Note:** CKEditor 5 Builds use [`Terser`](https://github.com/terser/terser) instead of `uglifyjs-webpack-plugin` because [the later one seems to be unsupported anymore](https://github.com/ckeditor/ckeditor5/issues/1353).
175
+
176
+
**Note:** CKEditor 5 builds use [`Terser`](https://github.com/terser/terser) instead of `uglifyjs-webpack-plugin` because [the later one seems to be unsupported anymore](https://github.com/ckeditor/ckeditor5/issues/1353).
Copy file name to clipboardexpand all lines: docs/framework/guides/support/license-and-legal.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Licensed under the terms of [GNU General Public License Version 2 or later](http
18
18
19
19
Where not otherwise indicated, all CKEditor 5 Framework content is authored by CKSource engineers and consists of CKSource-owned intellectual property. In some specific instances, CKEditor will incorporate work done by developers outside of CKSource with their express permission.
20
20
21
-
The {@link features/image-upload#easy-image Easy Image} feature present in {@link builds/index CKEditor 5 Builds} integrates with [CKEditor Cloud Services](https://ckeditor.com/ckeditor-cloud-services), if configured to do so. CKEditor Cloud Services is an external "Software as a Service" solution, delivered with its own license terms and conditions.
21
+
The {@link features/image-upload#easy-image Easy Image} feature present in {@link builds/index CKEditor 5 builds} integrates with [CKEditor Cloud Services](https://ckeditor.com/ckeditor-cloud-services), if configured to do so. CKEditor Cloud Services is an external "Software as a Service" solution, delivered with its own license terms and conditions.
Copy file name to clipboardexpand all lines: docs/index.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ meta-description: Learn how to install, integrate, update, configure and develop
11
11
<dl><dt>{@link builds/index CKEditor 5 installation and update}</dt><dd>Learn how to install, integrate and configure CKEditor 5 from scratch or using predefined builds. More complex aspects, like creating custom builds or updating and migrating from an older version are explained here, too.</dd>
12
12
<dt>{@link framework/guides/overview CKEditor 5 Framework}</dt><dd>Learn how to work with CKEditor 5 Framework, customize it, create your own plugins and custom editors, change the UI or even bring your own UI to the editor.</dd>
13
13
<dt>{@link features/index CKEditor 5 Features}</dt><dd>Learn about the features available for CKEditor 5 – both the ones included in Builds and a plethora of others.</dd>
14
-
<dt>{@link examples/index CKEditor 5 Examples}</dt><dd>Try out all CKEditor 5 Builds. See some of the possible customizations of CKEditor.</dd>
14
+
<dt>{@link examples/index CKEditor 5 Examples}</dt><dd>Try out all CKEditor 5 builds. See some of the possible customizations of CKEditor.</dd>
15
15
<dt>{@link api/index CKEditor 5 API Reference}</dt><dd>A complete API documentation.</dd></dl>
Copy file name to clipboardexpand all lines: packages/ckeditor5-editor-balloon/README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ The balloon editor implementation (Medium-like editor) for CKEditor 5.
9
9
10
10
This package contains the [`BalloonEditor`](https://ckeditor.com/docs/ckeditor5/latest/api/module_editor-balloon_ballooneditor-BalloonEditor.html) class. Follow there to learn more about this type of editor and how to initialize it.
11
11
12
-
This package contains the source version of the balloon editor. This editor implementation is also available in the [balloon build](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-balloon). Read more about [CKEditor 5 Builds](https://ckeditor.com/docs/ckeditor5/latest/builds/index.html).
12
+
This package contains the source version of the balloon editor. This editor implementation is also available in the [balloon build](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-balloon). Read more about [CKEditor 5 builds](https://ckeditor.com/docs/ckeditor5/latest/builds/index.html).
Copy file name to clipboardexpand all lines: packages/ckeditor5-editor-balloon/docs/api/editor-balloon.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ The balloon editor implementation (Medium-like editor) for CKEditor 5. See the {
12
12
13
13
This package contains the {@link module:editor-balloon/ballooneditor~BalloonEditor} class. Follow there to learn more about this type of editor and how to initialize it.
14
14
15
-
This package contains the source version of the balloon editor. This editor implementation is also available in the [balloon build](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-balloon). Read more about {@link builds/index CKEditor 5 Builds}.
15
+
This package contains the source version of the balloon editor. This editor implementation is also available in the [balloon build](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-balloon). Read more about {@link builds/index CKEditor 5 builds}.
Copy file name to clipboardexpand all lines: packages/ckeditor5-editor-classic/README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ The classic editor implementation for CKEditor 5.
9
9
10
10
This package contains the [`ClassicEditor`](https://ckeditor.com/docs/ckeditor5/latest/api/module_editor-classic_classiceditor-ClassicEditor.html) class. Follow there to learn more about this type of editor and how to initialize it.
11
11
12
-
This package contains the source version of the classic editor. This editor implementation is also available in the [classic build](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-classic). Read more about [CKEditor 5 Builds](https://ckeditor.com/docs/ckeditor5/latest/builds/index.html).
12
+
This package contains the source version of the classic editor. This editor implementation is also available in the [classic build](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-classic). Read more about [CKEditor 5 builds](https://ckeditor.com/docs/ckeditor5/latest/builds/index.html).
0 commit comments