Maciej Gołaszewski c7a34d5fde Add missing ckeditor5-core dependency. 7 years ago
..
.github d9953dfe10 The initial commit. 8 years ago
build 4c5d9f62c0 Internal: Build. 7 years ago
sample e472546255 Internal: The demo should fit. 7 years ago
src b91dbcf5d5 Feature: Introduced the CKFinder integration plugin. 7 years ago
tests ce9e1ca539 Add memory leak test. 7 years ago
.editorconfig d9953dfe10 The initial commit. 8 years ago
.eslintrc.js 3bc32feac8 Added a configuration for ESLint. 7 years ago
.gitattributes d9953dfe10 The initial commit. 8 years ago
.gitignore d9953dfe10 The initial commit. 8 years ago
.travis.yml 44e354059b Fixed formatting in Travis configuration file. 7 years ago
CHANGELOG.md 4726305fcb Docs: Corrected the changelog. [skip ci] 7 years ago
CONTRIBUTING.md 1d55567f33 Docs: Made contributing guide link to our docs. [skip ci] 7 years ago
LICENSE.md 219b1dc60c Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. 7 years ago
README.md 09e0941540 Docs: Added build status badges to the README. See: ckeditor/ckeditor5#1236. 7 years ago
package.json c7a34d5fde Add missing ckeditor5-core dependency. 7 years ago
webpack.config.js 9cfcb25b96 Removed unnecessary comment in `webpack.config.js`. 7 years ago

README.md

CKEditor 5 document editor build

npm version Build Status BrowserStack Status
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.