dkonopka 4828528a28 Added build screenshot to README.md. 7 years ago
..
.github 8f4f24dc07 Internal: Various maintanance changes. 8 years ago
build 5f42d1f63e Internal: Build. 7 years ago
sample 716c156de6 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. 7 years ago
src 50cd66f4a3 Internal: Further builds simplifications plus some comments. 7 years ago
tests 5ceafb961a Internal: Aligned code to changes in ckeditor5-core. See ckeditor/ckeditor5-core#140. 7 years ago
.editorconfig f5f6466a64 Initial commit. 8 years ago
.gitattributes a71f36861c Various improvements. 8 years ago
.gitignore 09fb5ae800 Internal: Added "package-lock.json" to ignored files. See ckeditor/ckeditor5-build-balloon#6. 7 years ago
CHANGELOG.md 716c156de6 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. 7 years ago
CONTRIBUTING.md a71f36861c Various improvements. 8 years ago
LICENSE.md e04c2dcb2b Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. 7 years ago
README.md 4828528a28 Added build screenshot to README.md. 7 years ago
package.json 98f0150257 Upgraded version of ESLint. 7 years ago
webpack.config.js 0344c4e4b3 Removed unnecessary comment in `webpack.config.js`. 7 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.

CKEditor 5 classic editor build screenshot

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 the CommonJS version:
// 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 terms of GNU General Public License Version 2 or later. For full details about the license, please check the LICENSE.md file.