Aleksander Nowodzinski 5c55b0144f Internal: Build. %!s(int64=7) %!d(string=hai) anos
..
.github d9953dfe10 The initial commit. %!s(int64=7) %!d(string=hai) anos
build 5c55b0144f Internal: Build. %!s(int64=7) %!d(string=hai) anos
sample 994a538964 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. %!s(int64=7) %!d(string=hai) anos
src 9c95b61761 Added Media Embed feature to the build. %!s(int64=7) %!d(string=hai) anos
tests 666bb2c086 Tests: Fixed broken styles in the cjs manual test. %!s(int64=7) %!d(string=hai) anos
.editorconfig d9953dfe10 The initial commit. %!s(int64=7) %!d(string=hai) anos
.gitattributes d9953dfe10 The initial commit. %!s(int64=7) %!d(string=hai) anos
.gitignore d9953dfe10 The initial commit. %!s(int64=7) %!d(string=hai) anos
CHANGELOG.md 994a538964 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. %!s(int64=7) %!d(string=hai) anos
CONTRIBUTING.md 550452f017 The basic implementation of the decoupled document build. %!s(int64=7) %!d(string=hai) anos
LICENSE.md 219b1dc60c Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. %!s(int64=7) %!d(string=hai) anos
README.md 994a538964 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. %!s(int64=7) %!d(string=hai) anos
package.json 5c55b0144f Internal: Build. %!s(int64=7) %!d(string=hai) anos
webpack.config.js 9cfcb25b96 Removed unnecessary comment in `webpack.config.js`. %!s(int64=7) %!d(string=hai) anos

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.