Aleksander Nowodzinski 78b71aa39d Other: Updated the path to the ClassicEditor class (see https://github.com/ckeditor/ckeditor5-editor-classic/issues/41). 8 years ago
..
bin 8dca94f360 Renamed the config file, updated README and aligned to new API of dev-utils - bundler. 8 years ago
build 4e3cd3326f Added new builds. 8 years ago
sample 5eb706991a Feature: Added block quotes feature. Closes #5. 8 years ago
tests 78b71aa39d Other: Updated the path to the ClassicEditor class (see https://github.com/ckeditor/ckeditor5-editor-classic/issues/41). 8 years ago
.editorconfig f5f6466a64 Initial commit. 8 years ago
.gitattributes a71f36861c Various improvements. 8 years ago
.gitignore a71f36861c Various improvements. 8 years ago
.npmignore b2d103542a Added dot files. 8 years ago
CHANGELOG.md 31ff009b42 Docs: Changelog. [skip ci] 8 years ago
CONTRIBUTING.md a71f36861c Various improvements. 8 years ago
LICENSE.md a71f36861c Various improvements. 8 years ago
README.md 8dca94f360 Renamed the config file, updated README and aligned to new API of dev-utils - bundler. 8 years ago
build-config.js 78b71aa39d Other: Updated the path to the ClassicEditor class (see https://github.com/ckeditor/ckeditor5-editor-classic/issues/41). 8 years ago
ckeditor.js 78b71aa39d Other: Updated the path to the ClassicEditor class (see https://github.com/ckeditor/ckeditor5-editor-classic/issues/41). 8 years ago
package.json d3a48aa6d8 Bumped up dev-utils. 8 years ago
webpack.compat.config.js 4736a3b3e8 Fix: CSS should be minified. Closes #7. 8 years ago
webpack.config.js 4736a3b3e8 Fix: CSS should be minified. Closes #7. 8 years ago

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 build-config.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.