Kamil Piechaczek ebd2f15d6f Internal: Upgraded CI environment to use Xenial version of the distro. See ckeditor/ckeditor#2041. 6 years ago
..
.github 8f4f24dc07 Internal: Various maintanance changes. 8 years ago
build 0bed076377 Internal: Build. 6 years ago
sample 716c156de6 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. 7 years ago
src 35620fa2a5 Internal: Updated the license header. See ckeditor/ckeditor5#1557. [skip ci] 6 years ago
tests 22db090880 All tests require an image that exists. It will not cause the 404 error. 6 years ago
.editorconfig f5f6466a64 Initial commit. 8 years ago
.eslintrc.js 35620fa2a5 Internal: Updated the license header. See ckeditor/ckeditor5#1557. [skip ci] 6 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
.travis.yml ebd2f15d6f Internal: Upgraded CI environment to use Xenial version of the distro. See ckeditor/ckeditor#2041. 6 years ago
CHANGELOG.md 40ee0bedfb Docs: Corrected the changelog. [skip ci] 6 years ago
CONTRIBUTING.md ec48b161de Docs: Made contributing guide link to our docs. [skip ci] 7 years ago
LICENSE.md ba4df7e987 Internal: Bumped the year. [skip ci] 6 years ago
README.md 5d4acf1981 Docs: Removed gitter badge. See ckeditor/ckeditor5#2037. [skip ci] 6 years ago
package.json dfe1039c67 Release: v12.4.0. [skip ci] 6 years ago
webpack.config.js d83a540318 Bumped style-loader to v1.0.0. Aligned the webpack config to the new loader API. 6 years ago

README.md

CKEditor 5 classic editor build

npm version Build Status
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 or https://ckeditor.com/legal/ckeditor-oss-license.