Piotrek Koszuliński 8c0a7c9b71 Internal: Updated dependencies. [skip ci] 7 vuotta sitten
..
.github d9953dfe10 The initial commit. 7 vuotta sitten
build a58992b3c4 Internal: Build. 7 vuotta sitten
sample e472546255 Internal: The demo should fit. 7 vuotta sitten
src b91dbcf5d5 Feature: Introduced the CKFinder integration plugin. 7 vuotta sitten
tests 666bb2c086 Tests: Fixed broken styles in the cjs manual test. 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 4726305fcb Docs: Corrected the changelog. [skip ci] 7 vuotta sitten
CONTRIBUTING.md 1d55567f33 Docs: Made contributing guide link to our docs. [skip ci] 7 vuotta sitten
LICENSE.md 219b1dc60c Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. 7 vuotta sitten
README.md 92c6becd09 Docs: Fixed code style. 7 vuotta sitten
package.json 8c0a7c9b71 Internal: Updated dependencies. [skip ci] 7 vuotta sitten
webpack.config.js 9cfcb25b96 Removed unnecessary comment in `webpack.config.js`. 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.

CKEditor 5 decoupled document editor build screenshot

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.