Piotrek Koszuliński 5efde5df96 Merge branch 'master' into t/ckeditor5/645 8 years ago
..
.github 8f4f24dc07 Internal: Various maintanance changes. 8 years ago
bin 4a0c8dfc2d Internal: Bumped the year. [skip ci] 8 years ago
build 4a0c8dfc2d Internal: Bumped the year. [skip ci] 8 years ago
sample 50d9c5f1d2 Docs: Improved the sample. See ckeditor/ckeditor5#535. 8 years ago
src 5efde5df96 Merge branch 'master' into t/ckeditor5/645 8 years ago
tests e121b034d5 Adjusted toolbar configuration of the build. 8 years ago
.editorconfig f5f6466a64 Initial commit. 9 years ago
.gitattributes a71f36861c Various improvements. 8 years ago
.gitignore 02587786ce Internal: Remove gulp dependency for pre-commit linting. 8 years ago
CHANGELOG.md 9a2b6237ef Docs: Fixed links in the changelog. [skip ci] 8 years ago
CONTRIBUTING.md a71f36861c Various improvements. 8 years ago
LICENSE.md 4a0c8dfc2d Internal: Bumped the year. [skip ci] 8 years ago
README.md 10ca8536d5 Docs: README page corrected. [skip ci] 8 years ago
build-config.js 5efde5df96 Merge branch 'master' into t/ckeditor5/645 8 years ago
package.json 72802c3d70 Internal: Downgraded webpack-sources because https://github.com/ckeditor/ckeditor5/issues/658 is still a problem. 8 years ago
webpack.config.js 4a0c8dfc2d Internal: Bumped the year. [skip ci] 8 years ago

README.md

CKEditor 5 classic editor build

npm version Dependency Status devDependency Status

The classic editor build for CKEditor 5. Read more about the classic editor build and see the demo.

Documentation

See:

Quick start

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';

// Or using CommonJS verion:
// const ClassicEditor = require( '@ckeditor/ckeditor5-build-classic' );

ClassicEditor
	.create( document.querySelector( '#editor' ) )
	.then( editor => {
		window.editor = editor;
	} )
	.catch( err => {
		console.error( err.stack );
	} );

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 Advanced setup guide.

License

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