|
|
@@ -5,7 +5,73 @@ CKEditor 5 classic build
|
|
|
[](https://david-dm.org/ckeditor/ckeditor5-build-classic)
|
|
|
[](https://david-dm.org/ckeditor/ckeditor5-build-classic?type=dev)
|
|
|
|
|
|
-Classic build of CKEditor 5. More information about the project can be found at the following URL: <https://github.com/ckeditor/ckeditor5-build-classic>.
|
|
|
+Classic build of CKEditor 5. Features the [classic creator](https://github.com/ckeditor/ckeditor5-editor-classic) and the standard set of article features.
|
|
|
+
|
|
|
+## Bundles
|
|
|
+
|
|
|
+The package contain two bundles of the classic editor:
|
|
|
+
|
|
|
+* `build/ckeditor.js` – minified, ES6 version of the bundle,
|
|
|
+* `build/ckeditor.compat.js` – minified, backward-compatible version of the bundle (`babel-preset-env` is configured to support `[ 'last 2 versions', 'ie >= 11' ]`).
|
|
|
+
|
|
|
+## Usage
|
|
|
+
|
|
|
+First, install the build from npm:
|
|
|
+
|
|
|
+```
|
|
|
+npm install --save @ckeditor/ckeditor5-build-classic
|
|
|
+```
|
|
|
+
|
|
|
+And use it in your website:
|
|
|
+
|
|
|
+```html
|
|
|
+<div id="editor">
|
|
|
+ <p>This is the editor content.</p>
|
|
|
+</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 );
|
|
|
+ } );
|
|
|
+</script>
|
|
|
+```
|
|
|
+
|
|
|
+Or in your JavaScript application:
|
|
|
+
|
|
|
+```js
|
|
|
+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' ) )
|
|
|
+ .then( editor => {
|
|
|
+ window.editor = editor;
|
|
|
+ } )
|
|
|
+ .catch( err => {
|
|
|
+ console.error( err.stack );
|
|
|
+ } );
|
|
|
+```
|
|
|
+
|
|
|
+**Note:** If you're planning to integrate CKEditor 5 deep into your application it's 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 `config-editor.js`, `config-build.js` or any of the Webpack configs 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`.
|
|
|
|
|
|
## License
|
|
|
|