Piotrek Koszuliński ca45ab7cc5 Tests: Fixed tests after recent dir structure changes. 8 years ago
..
.github 8f4f24dc07 Internal: Various maintanance changes. 8 years ago
bin 7abf4fd887 Moved "ckeditor.js" file to "src/" directory. 8 years ago
build d145f222d3 Changed the way how the build is exported, so it is available as the default export. 8 years ago
sample 50d9c5f1d2 Docs: Improved the sample. See ckeditor/ckeditor5#535. 8 years ago
src a55feff9d1 Source file should export the editor as default. 8 years ago
tests ca45ab7cc5 Tests: Fixed tests after recent dir structure changes. 8 years ago
.editorconfig f5f6466a64 Initial commit. 8 years ago
.gitattributes a71f36861c Various improvements. 8 years ago
.gitignore ee15f0ae64 Use a more standard directory/ notation in .gitignore. 8 years ago
CHANGELOG.md c2fd12706d Docs: Changelog. [skip ci] 8 years ago
CONTRIBUTING.md a71f36861c Various improvements. 8 years ago
LICENSE.md 8f4f24dc07 Internal: Various maintanance changes. 8 years ago
README.md 9b1a760a28 Docs: Improved editors and builds docs. 8 years ago
build-config.js eaaba0c47d Internal: The ckeditor5-presets became ckeditor5-essentials. See ckeditor/ckeditor5-essentials#1. 8 years ago
package.json d1cf8d6ca1 Merge pull request #25 from ckeditor/t/23 8 years ago
webpack.config.js 7abf4fd887 Moved "ckeditor.js" file to "src/" directory. 8 years ago

README.md

CKEditor 5 classic editor build

npm version Dependency Status devDependency Status

The classic editor build. 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.