ckeditor5 37.0.0-alpha.3 → 37.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +415 -0
- package/README.md +44 -36
- package/build/ckeditor5-dll.js +1 -1
- package/build/ckeditor5-dll.manifest.json +4 -0
- package/build/translations/sr-latn.js +1 -1
- package/build/translations/sr.js +1 -1
- package/package.json +15 -15
package/README.md
CHANGED
|
@@ -9,34 +9,38 @@ CKEditor 5 [](http://eepurl.com/c3zRPr)
|
|
10
10
|
[](https://twitter.com/ckeditor)
|
|
11
11
|
|
|
12
|
-
CKEditor 5 is an ultra-modern JavaScript rich
|
|
12
|
+
CKEditor 5 is an ultra-modern JavaScript rich-text editor with MVC architecture, a custom data model, and virtual DOM. It is written from scratch in TypeScript and has excellent webpack and Vite support. It provides every type of WYSIWYG editing solution imaginable with extensive collaboration support. From editors similar to Google Docs and Medium to Slack or Twitter-like applications, all is possible within a single editing framework. As a market leader, it is constantly expanded and updated.
|
|
13
13
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
## Table of contents
|
|
17
17
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
18
|
+
- [CKEditor 5 ](#ckeditor-5-)
|
|
19
|
+
- [Table of contents](#table-of-contents)
|
|
20
|
+
- [Quick start](#quick-start)
|
|
21
|
+
- [CKEditor 5 online builder](#ckeditor-5-online-builder)
|
|
22
|
+
- [CKEditor 5 predefined builds](#ckeditor-5-predefined-builds)
|
|
23
|
+
- [Example installation](#example-installation)
|
|
24
|
+
- [CKEditor 5 advanced installation](#ckeditor-5-advanced-installation)
|
|
25
|
+
- [CKEditor 5 Framework](#ckeditor-5-framework)
|
|
26
|
+
- [Documentation and FAQ](#documentation-and-faq)
|
|
27
|
+
- [Releases](#releases)
|
|
28
|
+
- [Editing and collaboration features](#editing-and-collaboration-features)
|
|
29
|
+
- [Contributing and project organization](#contributing-and-project-organization)
|
|
30
|
+
- [Ideas and discussions](#ideas-and-discussions)
|
|
31
|
+
- [Development](#development)
|
|
32
|
+
- [Reporting issues and feature requests](#reporting-issues-and-feature-requests)
|
|
33
|
+
- [License](#license)
|
|
30
34
|
|
|
31
35
|
## Quick start
|
|
32
36
|
|
|
33
|
-
### CKEditor 5
|
|
37
|
+
### CKEditor 5 online builder
|
|
34
38
|
|
|
35
|
-
The
|
|
39
|
+
The easiest way to start using CKEditor 5 with all the features you need, is to prepare a customized build with the [online builder](https://ckeditor.com/ckeditor-5/online-builder/). All you need to do is choose the preferred predefined build as a base, add all the required plugins, and download the ready-to-use package. Refer to the [Online builder Quick start](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/quick-start.html#creating-custom-builds-with-online-builder) guide to follow this installation path.
|
|
36
40
|
|
|
37
41
|
### CKEditor 5 predefined builds
|
|
38
42
|
|
|
39
|
-
CKEditor 5 predefined builds are a set of ready-to-use rich text editors. Every
|
|
43
|
+
CKEditor 5 predefined 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
44
|
|
|
41
45
|
The following CKEditor 5 predefined builds are currently available:
|
|
42
46
|
|
|
@@ -53,54 +57,60 @@ Creating an editor using a CKEditor 5 build is very simple and can be described
|
|
|
53
57
|
1. Load the desired editor via the `<script>` tag.
|
|
54
58
|
2. Call the static `create()` method to create the editor.
|
|
55
59
|
|
|
56
|
-
In your HTML page add an element that CKEditor should replace:
|
|
60
|
+
In your HTML page, add an element that CKEditor should replace:
|
|
57
61
|
|
|
58
62
|
```html
|
|
59
63
|
<div id="editor"></div>
|
|
60
64
|
```
|
|
61
65
|
|
|
62
|
-
Load the classic editor build (you can choose between [CDN](https://cdn.ckeditor.com/#ckeditor5), [npm](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/predefined-builds.html#npm) and [zip downloads](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/predefined-builds.html#zip-download)):
|
|
66
|
+
Load the classic editor build (you can choose between the [CDN](https://cdn.ckeditor.com/#ckeditor5), [npm](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/predefined-builds.html#npm), and [zip downloads](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/predefined-builds.html#zip-download)):
|
|
63
67
|
|
|
64
68
|
```html
|
|
65
|
-
<script src="https://cdn.ckeditor.com/ckeditor5/
|
|
69
|
+
<script src="https://cdn.ckeditor.com/ckeditor5/37.0.0/classic/ckeditor.js"></script>
|
|
66
70
|
```
|
|
67
71
|
|
|
68
72
|
Call the [`ClassicEditor.create()`](https://ckeditor.com/docs/ckeditor5/latest/api/module_editor-classic_classiceditor-ClassicEditor.html#static-function-create) method:
|
|
69
73
|
|
|
70
74
|
```html
|
|
71
75
|
<script>
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
76
|
+
ClassicEditor
|
|
77
|
+
.create( document.querySelector( '#editor' ) )
|
|
78
|
+
.catch( error => {
|
|
79
|
+
console.error( error );
|
|
80
|
+
} );
|
|
77
81
|
</script>
|
|
78
82
|
```
|
|
79
83
|
|
|
80
84
|
You’re ready to go!
|
|
81
85
|
|
|
82
|
-
To find out how to start with other builds check the [Predefined builds](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/predefined-builds.html) guide in the CKEditor 5 documentation.
|
|
86
|
+
To find out how to start with other builds, check the [Predefined builds](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/predefined-builds.html) guide in the CKEditor 5 documentation.
|
|
83
87
|
|
|
84
88
|
### CKEditor 5 advanced installation
|
|
85
89
|
|
|
86
|
-
For more advanced users
|
|
90
|
+
For more advanced users or those who need to integrate CKEditor 5 with their applications, we have prepared several other, advanced methods to do it. You can:
|
|
91
|
+
* Integrate the editor from source [using webpack](https://ckeditor.com/docs/ckeditor5/latest/installation/advanced/alternative-setups/integrating-from-source-webpack.html) or [Vite](https://ckeditor.com/docs/ckeditor5/latest/installation/advanced/alternative-setups/integrating-from-source-vite.html)
|
|
92
|
+
* Use [DLL builds](https://ckeditor.com/docs/ckeditor5/latest/installation/advanced/alternative-setups/dll-builds.html)
|
|
93
|
+
* Use some of the pre-made integrations with popular [JavaScript frameworks](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/frameworks/overview.html):
|
|
94
|
+
* [Angular](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/frameworks/angular.html)
|
|
95
|
+
* [React](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/frameworks/react.html)
|
|
96
|
+
* [Vue](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/frameworks/vuejs-v3.html)
|
|
87
97
|
|
|
88
98
|
#### CKEditor 5 Framework
|
|
89
99
|
|
|
90
100
|
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.
|
|
91
101
|
|
|
92
|
-
To find out how to start building your
|
|
102
|
+
To find out how to start building your editor from scratch go to the [CKEditor 5 Framework overview](https://ckeditor.com/docs/ckeditor5/latest/framework/index.html) section of the CKEditor 5 documentation.
|
|
93
103
|
|
|
94
104
|
## Documentation and FAQ
|
|
95
105
|
|
|
96
|
-
|
|
106
|
+
Extensive documentation dedicated to all things CKEditor 5-related is available. You will find basic guides that will help you kick off your project, advanced deep-dive tutorials to tailor the editor to your specific needs, and help sections with solutions and answers to any of your possible questions. To find out more refer to the following [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/index.html) sections:
|
|
97
107
|
|
|
98
108
|
* [Installing CKEditor 5](https://ckeditor.com/docs/ckeditor5/latest/installation/index.html)
|
|
99
|
-
* [CKEditor 5 features
|
|
109
|
+
* [CKEditor 5 features](https://ckeditor.com/docs/ckeditor5/latest/features/index.html)
|
|
100
110
|
* [CKEditor 5 examples](https://ckeditor.com/docs/ckeditor5/latest/examples/index.html)
|
|
101
111
|
* [Updating CKEditor 5](https://ckeditor.com/docs/ckeditor5/latest/updating/index.html)
|
|
102
112
|
* [Getting CKEditor 5 support](https://ckeditor.com/docs/ckeditor5/latest/support/index.html)
|
|
103
|
-
* [CKEditor 5 Framework
|
|
113
|
+
* [CKEditor 5 Framework](https://ckeditor.com/docs/ckeditor5/latest/framework/index.html)
|
|
104
114
|
* [API documentation](https://ckeditor.com/docs/ckeditor5/latest/api/index.html)
|
|
105
115
|
|
|
106
116
|
For FAQ please go to the [CKEditor Ecosystem help center](https://support.ckeditor.com/hc/en-us).
|
|
@@ -112,11 +122,11 @@ Follow the [CKEditor 5 changelog](https://github.com/ckeditor/ckeditor5/blob/sta
|
|
|
112
122
|
|
|
113
123
|
## Editing and collaboration features
|
|
114
124
|
|
|
115
|
-
The CKEditor 5 Framework offers access to plethora of various plugins, supporting [all kinds of editing features](https://ckeditor.com/docs/ckeditor5/latest/features/index.html).
|
|
125
|
+
The CKEditor 5 Framework offers access to a plethora of various plugins, supporting [all kinds of editing features](https://ckeditor.com/docs/ckeditor5/latest/features/index.html).
|
|
116
126
|
|
|
117
|
-
From collaborative editing support providing comments and tracking changes, through editing tools that let users control the content looks and structure such as tables, lists, font styles, to accessibility helpers and multi-language support - CKEditor 5 is easily
|
|
127
|
+
From collaborative editing support providing comments and tracking changes, through editing tools that let users control the content looks and structure such as tables, lists, font styles, to accessibility helpers and multi-language support - CKEditor 5 is easily extensible and customizable. Special duty features like Markdown input and output and source editing, or export to PDF and Word provide solutions for users with diverse and specialized needs. Images and videos are easily supported and CKEditor 5 offers various upload and storage systems to manage these.
|
|
118
128
|
|
|
119
|
-
The number of options and the
|
|
129
|
+
The number of options and the ease of customization and adding new ones make the editing experience even better for any environment and professional background.
|
|
120
130
|
|
|
121
131
|
Refer to the [CKEditor 5 Features](https://ckeditor.com/docs/ckeditor5/latest/features/index.html) documentation for details.
|
|
122
132
|
|
|
@@ -136,9 +146,7 @@ See the [official contributors' guide](https://ckeditor.com/docs/ckeditor5/lates
|
|
|
136
146
|
|
|
137
147
|
### Reporting issues and feature requests
|
|
138
148
|
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
Read more on the [Getting support](https://ckeditor.com/docs/ckeditor5/latest/support/getting-support.html) guide.
|
|
149
|
+
Report issues in [the `ckeditor5` repository](https://github.com/ckeditor/ckeditor5/issues). Read more on the [Getting support](https://ckeditor.com/docs/ckeditor5/latest/support/getting-support.html) guide.
|
|
142
150
|
|
|
143
151
|
## License
|
|
144
152
|
|