Skip to content

Commit eb73717

Browse files
committed
Docs: reworking docs structure step 9.
1 parent 4a19ef3 commit eb73717

File tree

21 files changed

+37
-37
lines changed

21 files changed

+37
-37
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ A set of ready-to-use rich text editors created with a powerful framework. Made
1717
## Table of contents
1818

1919
* [Quick start](#quick-start)
20-
* [CKEditor 5 Builds](#ckeditor-5-builds)
20+
* [CKEditor 5 builds](#ckeditor-5-builds)
2121
* [CKEditor 5 Framework](#ckeditor-5-framework)
2222
* [Documentation and FAQ](#documentation-and-faq)
2323
* [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
3535

3636
## Quick start
3737

38-
### CKEditor 5 Builds
38+
### CKEditor 5 builds
3939

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.
4141

42-
The following CKEditor 5 Builds are currently available:
42+
The following CKEditor 5 builds are currently available:
4343

4444
* [Classic editor](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/overview.html#classic-editor)
4545
* [Inline editor](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/overview.html#inline-editor)
@@ -84,7 +84,7 @@ To find out how to start with other builds check the [Quick start guide in the C
8484

8585
### CKEditor 5 Framework
8686

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.
8888

8989
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).
9090

@@ -94,7 +94,7 @@ To find out more see the following [CKEditor 5 documentation](https://ckeditor.c
9494

9595
* [API documentation](https://ckeditor.com/docs/ckeditor5/latest/api/index.html)
9696
* [CKEditor 5 Framework documentation](https://ckeditor.com/docs/ckeditor5/latest/framework/index.html)
97-
* [CKEditor 5 Builds documentation](https://ckeditor.com/docs/ckeditor5/latest/builds/index.html)
97+
* [CKEditor 5 builds documentation](https://ckeditor.com/docs/ckeditor5/latest/builds/index.html)
9898
* [CKEditor 5 Features documentation](https://ckeditor.com/docs/ckeditor5/latest/features/index.html)
9999
* [CKEditor 5 Examples](https://ckeditor.com/docs/ckeditor5/latest/examples/index.html)
100100

docs/api/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ category: api-reference
1818
## Documentation
1919

2020
* {@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.
2323

2424
## Contribute
2525

docs/builds/guides/integration/advanced-setup.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ Webpack 4 introduced the [concept of modes](https://webpack.js.org/concepts/mode
381381
<info-box>
382382
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).
383383

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).
385385
</info-box>
386386

387387
### Option: Extracting CSS
@@ -441,7 +441,7 @@ Webpack will now create a separate file called `styles.css` which you will need
441441

442442
### Option: Building to ES5 target
443443

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.
445445

446446
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.
447447

docs/builds/guides/migration/migration-from-ckeditor-4.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ When compared to its predecessor, CKEditor 5 should be considered **a totally ne
1515

1616
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.
1717

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.
1919

2020
## Installation and integration
2121

docs/builds/guides/overview.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ order: 10
1111

1212
# Overview
1313

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.
1515

1616
## Available builds
1717

18-
The following CKEditor 5 Builds are currently available:
18+
The following CKEditor 5 builds are currently available:
1919

2020
* [Classic editor](#classic-editor)
2121
* [Inline editor](#inline-editor)

docs/builds/guides/support/license-and-legal.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ order: 20
88

99
# License and legal
1010

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.
1212

1313
Copyright (c) 2003-2021, CKSource Frederico Knabben. All rights reserved.
1414

@@ -20,7 +20,7 @@ If you are running a project with an OSS license incompatible with GPL, please [
2020

2121
## Sources of intellectual property included in CKEditor
2222

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.
2424

2525
## Trademarks
2626

docs/builds/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ category: builds
33
order: 10
44
toc: false
55
feedback-widget: false
6-
meta-title: CKEditor 5 Builds documentation
7-
meta-description: Learn how to install, integrate, configure and develop CKEditor 5 Builds. Browse through API documentation and online samples.
6+
meta-title: CKEditor 5 builds documentation
7+
meta-description: Learn how to install, integrate, configure and develop CKEditor 5 builds. Browse through API documentation and online samples.
88
---
99

1010
# Installing CKEditor 5
@@ -40,4 +40,4 @@ Refer to the {@link builds/guides/migration/migration-from-ckeditor-4 CKEditor 4
4040
## Related links
4141

4242
* {@link examples/index Examples} &ndash; Try live demos of all available builds.
43-
* {@link features/index Features} &ndash; Learn about some of the features included in CKEditor 5 Builds.
43+
* {@link features/index Features} &ndash; Learn about some of the features included in CKEditor 5 builds.

docs/examples/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ meta-description: Navigate through CKEditor 5 examples to see what you are able
1515

1616
## Related links
1717

18-
* {@link features/index Features} &ndash; Learn about some of the features included in CKEditor 5 Builds.
19-
* {@link builds/guides/overview CKEditor 5 Builds} &ndash; 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} &ndash; Learn about some of the features included in CKEditor 5 builds.
19+
* {@link builds/guides/overview CKEditor 5 builds} &ndash; Learn how to install, integrate and configure CKEditor 5 builds. More complex aspects, like creating custom builds, are explained here, too.</dd>
2020
* {@link framework/guides/overview CKEditor 5 Framework} &ndash; 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.

docs/features/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ If you want to migrate from CKEditor 4 to CKEditor 5, please check the {@link bu
9696

9797
## Feature availability
9898

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}.
100100

101101
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/).
102102

docs/framework/guides/overview.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ order: 10
55

66
# Overview
77

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 &mdash; 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 &mdash; thanks to CKEditor 5 Framework.
99

1010
This guide explains how the framework is built and how to start using it.
1111

1212
## When to use the framework?
1313

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.
1515

1616
* **Writing your own features.** Features are implemented using the framework.
1717
* **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:
4747
* [Editors](https://github.com/ckeditor/ckeditor5#editors) &ndash; Packages that implement various types of editors.
4848
* [Features](https://github.com/ckeditor/ckeditor5#features) &ndash; Packages that implement end user features.
4949
* [Themes](https://github.com/ckeditor/ckeditor5#themes) &ndash; Packages that implement editor themes.
50-
* [Builds](https://github.com/ckeditor/ckeditor5#builds) &ndash; Packages containing {@link builds/guides/overview CKEditor 5 Builds}.
50+
* [Builds](https://github.com/ckeditor/ckeditor5#builds) &ndash; Packages containing {@link builds/guides/overview CKEditor 5 builds}.
5151

5252
## What's next?
5353

docs/framework/guides/quick-start.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The CKEditor 5 Framework is made of several [npm packages](https://npmjs.com). T
1414
* [Node.js](https://nodejs.org/en/) 12.0.0+
1515
* 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)
1616

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.
1818

1919
<!-- TODO replace the link above when the Framework will get its own building guide. -->
2020

@@ -172,8 +172,8 @@ npm adds `./node_modules/.bin/` to the `PATH` automatically, so in this case you
172172
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/).
173173

174174
**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).
177177
</info-box>
178178

179179
If everything worked correctly, you should see:

docs/framework/guides/support/license-and-legal.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Licensed under the terms of [GNU General Public License Version 2 or later](http
1818

1919
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.
2020

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.
2222

2323
## Trademarks
2424

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ meta-description: Learn how to install, integrate, update, configure and develop
1111
<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>
1212
<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>
1313
<dt>{@link features/index CKEditor 5 Features}</dt><dd>Learn about the features available for CKEditor 5 &ndash; 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>
1515
<dt>{@link api/index CKEditor 5 API Reference}</dt><dd>A complete API documentation.</dd></dl>
1616

1717
## Contribute

packages/ckeditor5-editor-balloon/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The balloon editor implementation (Medium-like editor) for CKEditor 5.
99

1010
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.
1111

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).
1313

1414
## Documentation
1515

packages/ckeditor5-editor-balloon/docs/api/editor-balloon.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The balloon editor implementation (Medium-like editor) for CKEditor 5. See the {
1212

1313
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.
1414

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}.
1616

1717
## Installation
1818

packages/ckeditor5-editor-classic/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The classic editor implementation for CKEditor 5.
99

1010
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.
1111

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).
1313

1414
## Documentation
1515

0 commit comments

Comments
 (0)