8
0
Piotrek Koszuliński b423d5131c Note in the manual tests that they need the bundles to be rebuilt. 8 лет назад
..
bin 609c0093f2 Moved Webpack configs to this repository for simpler tinkering with them. 8 лет назад
build b423d5131c Note in the manual tests that they need the bundles to be rebuilt. 8 лет назад
sample 5df2f4655a Minor improvement in tests. 8 лет назад
tests b423d5131c Note in the manual tests that they need the bundles to be rebuilt. 8 лет назад
.editorconfig f5f6466a64 Initial commit. 8 лет назад
.gitattributes a71f36861c Various improvements. 8 лет назад
.gitignore a71f36861c Various improvements. 8 лет назад
.npmignore b2d103542a Added dot files. 8 лет назад
CONTRIBUTING.md a71f36861c Various improvements. 8 лет назад
LICENSE.md a71f36861c Various improvements. 8 лет назад
README.md 3bc37e2b87 Final cleanup. 8 лет назад
ckeditor.js b423d5131c Note in the manual tests that they need the bundles to be rebuilt. 8 лет назад
config-build.js b423d5131c Note in the manual tests that they need the bundles to be rebuilt. 8 лет назад
config-editor.js 332a560d24 Split config to two files. The first contains parameters for build, the second - for the editor. 8 лет назад
package.json 3bc37e2b87 Final cleanup. 8 лет назад
webpack.compat.config.js 609c0093f2 Moved Webpack configs to this repository for simpler tinkering with them. 8 лет назад
webpack.config.js 609c0093f2 Moved Webpack configs to this repository for simpler tinkering with them. 8 лет назад

README.md

CKEditor 5 classic build

npm version Dependency Status devDependency Status

Classic build of CKEditor 5. Features the classic creator 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:

<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:

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

Licensed under the GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the LICENSE.md file.