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

Commit

Permalink
Other: Removed the compat-type of build. Closes #20.
Browse files Browse the repository at this point in the history
  • Loading branch information
Reinmar committed Aug 31, 2017
1 parent 2579b6b commit 529a319
Show file tree
Hide file tree
Showing 9 changed files with 27 additions and 191 deletions.
48 changes: 19 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,18 @@ CKEditor 5 classic build
[![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-build-classic/status.svg)](https://david-dm.org/ckeditor/ckeditor5-build-classic)
[![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-build-classic/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-build-classic?type=dev)

Classic build of CKEditor 5. Features the [classic creator](https://github.com/ckeditor/ckeditor5-editor-classic) and the standard set of article features.
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).

## Bundles
## Documentation

The package contains two bundles of the classic editor:
See:

* `build/ckeditor.js` – A minified, ES6 version of the bundle.
* `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'`).
* [Installation](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/builds/guides/integration/installation.html) for how to install this package and what it contains.
* [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.
* [Configuration](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/builds/guides/integration/configuration.html) for how to configure the editor.
* [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).

## Usage
## Quick start

First, install the build from npm:

Expand All @@ -31,13 +33,14 @@ And use it in your website:
</div>
<script src="./node_modules/@ckeditor/ckeditor5-build-classic/build/ckeditor.js"></script>
<script>
ClassicEditor.create( document.querySelector( '#editor' ) )
.then( editor => {
window.editor = editor;
} )
.catch( err => {
console.error( err.stack );
} );
ClassicEditor
.create( document.querySelector( '#editor' ) )
.then( editor => {
window.editor = editor;
} )
.catch( err => {
console.error( err.stack );
} );
</script>
```

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

ClassicEditor.create( document.querySelector( '#editor' ) )
ClassicEditor
.create( document.querySelector( '#editor' ) )
.then( editor => {
window.editor = editor;
} )
Expand All @@ -58,21 +62,7 @@ ClassicEditor.create( document.querySelector( '#editor' ) )
} );
```

**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`).

## Rebuilding the bundle

**Note:** This section assumes that you cloned this package repository and execute the commands inside it.

You can modify `build-config.js` or any of the webpack configurations and run:

```
npm run build
```

to rebuild the entry point (`ckeditor.js`) and both builds (`build/*`).

You can also modify `ckeditor.js` directly and run one of `npm run build-ckeditor` or `npm run build-ckeditor-compat`.
**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).

## License

Expand Down
9 changes: 0 additions & 9 deletions bin/build-ckeditor-compat.sh

This file was deleted.

6 changes: 0 additions & 6 deletions build/ckeditor.compat.js

This file was deleted.

1 change: 0 additions & 1 deletion build/ckeditor.compat.js.map

This file was deleted.

16 changes: 8 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@
"name": "@ckeditor/ckeditor5-build-classic",
"version": "0.2.0",
"description": "CKEditor 5 classic build.",
"keywords": [],
"keywords": [
"ckeditor5-build",
"text editor",
"WYSIWYG",
"rich-text editor"
],
"main": "./build/ckeditor.js",
"dependencies": {
"@ckeditor/ckeditor5-editor-classic": "^0.7.3",
Expand All @@ -19,14 +24,10 @@
"devDependencies": {
"@ckeditor/ckeditor5-dev-utils": "^3.0.0",
"@ckeditor/ckeditor5-dev-webpack-plugin": "^2.0.11",
"babel-core": "^6.26.0",
"babel-loader": "^7.1.2",
"babel-preset-env": "^1.6.0",
"babel-minify-webpack-plugin": "^0.2.0",
"css-loader": "^0.28.5",
"node-sass": "^4.5.3",
"raw-loader": "^0.5.1",
"regenerator-runtime": "^0.11.0",
"sass-loader": "^6.0.6",
"style-loader": "^0.18.2",
"webpack": "^3.5.5"
Expand All @@ -44,9 +45,8 @@
"url": "https://github.com/ckeditor/ckeditor5-build-classic.git"
},
"scripts": {
"build": "npm run create-entry-file && npm run build-ckeditor && npm run build-ckeditor-compat",
"build": "npm run create-entry-file && npm run build-ckeditor",
"create-entry-file": "./bin/create-entry-file.js",
"build-ckeditor": "./bin/build-ckeditor.sh",
"build-ckeditor-compat": "./bin/build-ckeditor-compat.sh"
"build-ckeditor": "./bin/build-ckeditor.sh"
}
}
27 changes: 0 additions & 27 deletions tests/manual/ckeditor.compat.html

This file was deleted.

14 changes: 0 additions & 14 deletions tests/manual/ckeditor.compat.js

This file was deleted.

9 changes: 0 additions & 9 deletions tests/manual/ckeditor.compat.md

This file was deleted.

88 changes: 0 additions & 88 deletions webpack.compat.config.js

This file was deleted.

0 comments on commit 529a319

Please sign in to comment.