Piotrek Koszuliński 55cdd55e2d Internal: Build. 7 years ago
..
.github d9953dfe10 The initial commit. 8 years ago
build 55cdd55e2d Internal: Build. 7 years ago
sample 4c7476bb39 Docs: Fix nested editable styles in document editor sample. 7 years ago
src e8b5aaa768 Internal: Further builds simplifications plus some comments. 7 years ago
tests 666bb2c086 Tests: Fixed broken styles in the cjs manual test. 7 years ago
.editorconfig d9953dfe10 The initial commit. 8 years ago
.gitattributes d9953dfe10 The initial commit. 8 years ago
.gitignore d9953dfe10 The initial commit. 8 years ago
CHANGELOG.md aefd87cc8d Docs: Corrected the changelog. [skip ci] 7 years ago
CONTRIBUTING.md 550452f017 The basic implementation of the decoupled document build. 8 years ago
LICENSE.md 219b1dc60c Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. 7 years ago
README.md 219b1dc60c Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. 7 years ago
package.json 3c582e5249 Release: v11.0.0. 7 years ago
webpack.config.js 9cfcb25b96 Removed unnecessary comment in `webpack.config.js`. 7 years ago

README.md

CKEditor 5 document editor build

npm version Dependency Status devDependency Status

The document editor build for CKEditor 5, featuring the decoupled UI editor implementation. Read more about the document editor build and see the demo.

Documentation

See:

Quick start

First, install the build from npm:

npm install --save @ckeditor/ckeditor5-build-decoupled-document

And use it in your website:

<div id="editor">
	<p>This is the editor content.</p>
</div>
<script src="./node_modules/@ckeditor/ckeditor5-build-decoupled-document/build/ckeditor.js"></script>
<script>
	DecoupledEditor
		.create( '<h2>Hello world!</h2>', {
			toolbarContainer: document.querySelector( '.toolbar-container' ),
			editableContainer: document.querySelector( '.editable-container' )
		} )
		.then( editor => {
			window.editor = editor;
		} )
		.catch( err => {
			console.error( err.stack );
		} );
</script>

Or in your JavaScript application:

import DecoupledEditor from '@ckeditor/ckeditor5-build-decoupled-document';

// Or using the CommonJS version:
// const DecoupledEditor = require( '@ckeditor/ckeditor5-build-decoupled-document' );

DecoupledEditor
	.create( '<h2>Hello world!</h2>', {
			toolbarContainer: document.querySelector( '.toolbar-container' ),
			editableContainer: document.querySelector( '.editable-container' )
		} )
	.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.