Aleksander Nowodzinski a5eb7c0d7a Tests: Updated tests to the latest decoupled editor API. 7 lat temu
..
.github d9953dfe10 The initial commit. 7 lat temu
bin 550452f017 The basic implementation of the decoupled document build. 7 lat temu
build 5b0a54bfe8 Updated the build. 7 lat temu
sample 97d19c9895 Internal: Updated links to CKEditor 5 website. [skip ci] 7 lat temu
src db05885cd5 Internal: uploadImage is now called imageUpload. 7 lat temu
tests a5eb7c0d7a Tests: Updated tests to the latest decoupled editor API. 7 lat temu
.editorconfig d9953dfe10 The initial commit. 7 lat temu
.gitattributes d9953dfe10 The initial commit. 7 lat temu
.gitignore d9953dfe10 The initial commit. 7 lat temu
CHANGELOG.md 6140d49b45 Docs: Corrected the changelog. [skip ci] 7 lat temu
CONTRIBUTING.md 550452f017 The basic implementation of the decoupled document build. 7 lat temu
LICENSE.md ec5d419f95 Let's call it a document editor build for now (until we have more document builds). 7 lat temu
README.md 97d19c9895 Internal: Updated links to CKEditor 5 website. [skip ci] 7 lat temu
build-config.js db05885cd5 Internal: uploadImage is now called imageUpload. 7 lat temu
package.json 97d19c9895 Internal: Updated links to CKEditor 5 website. [skip ci] 7 lat temu
webpack.config.js 550452f017 The basic implementation of the decoupled document build. 7 lat temu

README.md

CKEditor 5 decoupled document build

npm version Dependency Status devDependency Status

The decoupled document build for CKEditor 5. Read more about the [decoupled document build]((https://docs.ckeditor.com/ckeditor5/latest/builds/guides/overview.html#document-editor) 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 CommonJS verion:
// 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.