Anna Tomanek 992e9a1e67 Docs: Fixed README. [skip ci] 7 vuotta sitten
..
.github d9953dfe10 The initial commit. 7 vuotta sitten
bin 550452f017 The basic implementation of the decoupled document build. 7 vuotta sitten
build fdd1669ef0 Internal: Build. 7 vuotta sitten
sample 19882068c4 Made the config.toolbarContainer and config.editableContainer accept only HTMLElement (previously also String). 7 vuotta sitten
src db05885cd5 Internal: uploadImage is now called imageUpload. 7 vuotta sitten
tests 19882068c4 Made the config.toolbarContainer and config.editableContainer accept only HTMLElement (previously also String). 7 vuotta sitten
.editorconfig d9953dfe10 The initial commit. 7 vuotta sitten
.gitattributes d9953dfe10 The initial commit. 7 vuotta sitten
.gitignore d9953dfe10 The initial commit. 7 vuotta sitten
CHANGELOG.md 6140d49b45 Docs: Corrected the changelog. [skip ci] 7 vuotta sitten
CONTRIBUTING.md 550452f017 The basic implementation of the decoupled document build. 7 vuotta sitten
LICENSE.md ec5d419f95 Let's call it a document editor build for now (until we have more document builds). 7 vuotta sitten
README.md 992e9a1e67 Docs: Fixed README. [skip ci] 7 vuotta sitten
build-config.js db05885cd5 Internal: uploadImage is now called imageUpload. 7 vuotta sitten
package.json b0c7c042e8 Release: v1.0.0-beta.1. 7 vuotta sitten
webpack.config.js 550452f017 The basic implementation of the decoupled document build. 7 vuotta sitten

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>
	DecoupledDocumentEditor
		.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 DecoupledDocumentEditor from '@ckeditor/ckeditor5-build-decoupled-document';

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

DecoupledDocumentEditor
	.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 GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the LICENSE.md file.