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

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://ckeditor5.github.io/docs/nightly/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.