Skip to content
This repository was archived by the owner on Jun 26, 2020. It is now read-only.

Commit 529a319

Browse files
committed
Other: Removed the compat-type of build. Closes #20.
1 parent 2579b6b commit 529a319

9 files changed

+27
-191
lines changed

README.md

+19-29
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,18 @@ CKEditor 5 classic build
66
[![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-build-classic/status.svg)](https://david-dm.org/ckeditor/ckeditor5-build-classic)
77
[![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-build-classic/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-build-classic?type=dev)
88

9-
Classic build of CKEditor 5. Features the [classic creator](https://github.com/ckeditor/ckeditor5-editor-classic) and the standard set of article features.
9+
Classic build of CKEditor 5. Read more in the [classic editor](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/builds/guides/overview.html#Classic-editor) and see the [demo](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/examples/builds/classic-editor.html).
1010

11-
## Bundles
11+
## Documentation
1212

13-
The package contains two bundles of the classic editor:
13+
See:
1414

15-
* `build/ckeditor.js` – A minified, ES6 version of the bundle.
16-
* `build/ckeditor.compat.js` – A minified, backward-compatible version of the bundle ([babel-preset-env](https://github.com/babel/babel-preset-env) is configured to support `'last 2 versions'`, `'ie >= 11'`).
15+
* [Installation](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/builds/guides/integration/installation.html) for how to install this package and what it contains.
16+
* [Basic API](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/builds/guides/integration/installation.html) for how to create an editor and interact with it.
17+
* [Configuration](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/builds/guides/integration/configuration.html) for how to configure the editor.
18+
* [Creating custom builds](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/builds/guides/development/custom-builds.html) for how to customize the build (configure and rebuild the editor bundle).
1719

18-
## Usage
20+
## Quick start
1921

2022
First, install the build from npm:
2123

@@ -31,13 +33,14 @@ And use it in your website:
3133
</div>
3234
<script src="./node_modules/@ckeditor/ckeditor5-build-classic/build/ckeditor.js"></script>
3335
<script>
34-
ClassicEditor.create( document.querySelector( '#editor' ) )
35-
.then( editor => {
36-
window.editor = editor;
37-
} )
38-
.catch( err => {
39-
console.error( err.stack );
40-
} );
36+
ClassicEditor
37+
.create( document.querySelector( '#editor' ) )
38+
.then( editor => {
39+
window.editor = editor;
40+
} )
41+
.catch( err => {
42+
console.error( err.stack );
43+
} );
4144
</script>
4245
```
4346

@@ -49,7 +52,8 @@ import { ClassicEditor } from '@ckeditor/ckeditor5-build-classic/build/ckeditor'
4952
// Or using CommonJS verion:
5053
// const ClassicEditor = require( '@ckeditor/ckeditor5-build-classic/build/ckeditor' ).ClassicEditor;
5154

52-
ClassicEditor.create( document.querySelector( '#editor' ) )
55+
ClassicEditor
56+
.create( document.querySelector( '#editor' ) )
5357
.then( editor => {
5458
window.editor = editor;
5559
} )
@@ -58,21 +62,7 @@ ClassicEditor.create( document.querySelector( '#editor' ) )
5862
} );
5963
```
6064

61-
**Note:** If you are planning to integrate CKEditor 5 deep into your application it is actually more convenient and recommended to install and import the source modules directly (like it happens in `ckeditor.js`).
62-
63-
## Rebuilding the bundle
64-
65-
**Note:** This section assumes that you cloned this package repository and execute the commands inside it.
66-
67-
You can modify `build-config.js` or any of the webpack configurations and run:
68-
69-
```
70-
npm run build
71-
```
72-
73-
to rebuild the entry point (`ckeditor.js`) and both builds (`build/*`).
74-
75-
You can also modify `ckeditor.js` directly and run one of `npm run build-ckeditor` or `npm run build-ckeditor-compat`.
65+
**Note:** If you are planning to integrate CKEditor 5 deep into your application it is actually more convenient and recommended to install and import the source modules directly (like it happens in `ckeditor.js`). Read more in the [Bundling guide](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/builds/guides/integration/bundling.html).
7666

7767
## License
7868

bin/build-ckeditor-compat.sh

-9
This file was deleted.

build/ckeditor.compat.js

-6
This file was deleted.

build/ckeditor.compat.js.map

-1
This file was deleted.

package.json

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22
"name": "@ckeditor/ckeditor5-build-classic",
33
"version": "0.2.0",
44
"description": "CKEditor 5 classic build.",
5-
"keywords": [],
5+
"keywords": [
6+
"ckeditor5-build",
7+
"text editor",
8+
"WYSIWYG",
9+
"rich-text editor"
10+
],
611
"main": "./build/ckeditor.js",
712
"dependencies": {
813
"@ckeditor/ckeditor5-editor-classic": "^0.7.3",
@@ -19,14 +24,10 @@
1924
"devDependencies": {
2025
"@ckeditor/ckeditor5-dev-utils": "^3.0.0",
2126
"@ckeditor/ckeditor5-dev-webpack-plugin": "^2.0.11",
22-
"babel-core": "^6.26.0",
23-
"babel-loader": "^7.1.2",
24-
"babel-preset-env": "^1.6.0",
2527
"babel-minify-webpack-plugin": "^0.2.0",
2628
"css-loader": "^0.28.5",
2729
"node-sass": "^4.5.3",
2830
"raw-loader": "^0.5.1",
29-
"regenerator-runtime": "^0.11.0",
3031
"sass-loader": "^6.0.6",
3132
"style-loader": "^0.18.2",
3233
"webpack": "^3.5.5"
@@ -44,9 +45,8 @@
4445
"url": "https://github.com/ckeditor/ckeditor5-build-classic.git"
4546
},
4647
"scripts": {
47-
"build": "npm run create-entry-file && npm run build-ckeditor && npm run build-ckeditor-compat",
48+
"build": "npm run create-entry-file && npm run build-ckeditor",
4849
"create-entry-file": "./bin/create-entry-file.js",
49-
"build-ckeditor": "./bin/build-ckeditor.sh",
50-
"build-ckeditor-compat": "./bin/build-ckeditor-compat.sh"
50+
"build-ckeditor": "./bin/build-ckeditor.sh"
5151
}
5252
}

tests/manual/ckeditor.compat.html

-27
This file was deleted.

tests/manual/ckeditor.compat.js

-14
This file was deleted.

tests/manual/ckeditor.compat.md

-9
This file was deleted.

webpack.compat.config.js

-88
This file was deleted.

0 commit comments

Comments
 (0)