Marek Lewandowski a0093ced44 Internal: Build. 6 lat temu
..
.github d9953dfe10 The initial commit. 8 lat temu
build a0093ced44 Internal: Build. 6 lat temu
sample e472546255 Internal: The demo should fit. 7 lat temu
src c861abe912 Feature: Enabled the indent feature in the build. 6 lat temu
tests e1a27ab4b2 All tests require an image that exists. It will not cause the 404 error. 6 lat temu
.editorconfig d9953dfe10 The initial commit. 8 lat temu
.eslintrc.js b268d08178 Internal: Updated the license header. See ckeditor/ckeditor5#1557. [skip ci] 6 lat temu
.gitattributes d9953dfe10 The initial commit. 8 lat temu
.gitignore d9953dfe10 The initial commit. 8 lat temu
.travis.yml 6ced342281 Internal: Upgraded CI environment to use Xenial version of the distro. See ckeditor/ckeditor#2041. 6 lat temu
CHANGELOG.md 973dc7ca16 Docs: Corrected the changelog. [skip ci] 6 lat temu
CONTRIBUTING.md 1d55567f33 Docs: Made contributing guide link to our docs. [skip ci] 7 lat temu
LICENSE.md 696b5c0be4 Internal: Bumped the year. [skip ci] 7 lat temu
README.md 1c23295df9 Docs: Fixed code listing in the README.md. 6 lat temu
package.json f9428ec7cc Internal: Updated dependencies. [skip ci] 6 lat temu
webpack.config.js 66cdf1ceef Bumped style-loader to v1.0.0. Aligned the webpack config to the new loader API. 6 lat temu

README.md

CKEditor 5 document editor build

npm version Build 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="toolbar-container"></div>
<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( document.querySelector( '#editor' ) )
		.then( editor => {
			// The toolbar needs to be explicitly appended.
			document.querySelector( '#toolbar-container' ).appendChild( editor.ui.view.toolbar.element );

			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( document.querySelector( '#editor' ) )
		.then( editor => {
			// The toolbar needs to be explicitly appended.
			document.querySelector( '#toolbar-container' ).appendChild( editor.ui.view.toolbar.element );

			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 or https://ckeditor.com/legal/ckeditor-oss-license.