Piotrek Koszuliński b85de4d710 Internal: Updated dependencies. [skip ci] há 7 anos atrás
..
.github d9953dfe10 The initial commit. há 8 anos atrás
bin 550452f017 The basic implementation of the decoupled document build. há 7 anos atrás
build d644ddb94b Internal: Build. há 7 anos atrás
sample 4c7476bb39 Docs: Fix nested editable styles in document editor sample. há 7 anos atrás
src b73673aa68 Changed editor config - image can be configured to left, right or full. há 7 anos atrás
tests 18982ebde3 Other: Renamed the export name from `DecoupledDocumentEditor` to `DecoupledEditor`. Closes #6. há 7 anos atrás
.editorconfig d9953dfe10 The initial commit. há 8 anos atrás
.gitattributes d9953dfe10 The initial commit. há 8 anos atrás
.gitignore d9953dfe10 The initial commit. há 8 anos atrás
CHANGELOG.md 4d76eeb70c Docs: Corrected the changelog. [skip ci] há 7 anos atrás
CONTRIBUTING.md 550452f017 The basic implementation of the decoupled document build. há 7 anos atrás
LICENSE.md 0d5b1b1064 Internal: Improved license file. há 7 anos atrás
README.md 18982ebde3 Other: Renamed the export name from `DecoupledDocumentEditor` to `DecoupledEditor`. Closes #6. há 7 anos atrás
build-config.js b73673aa68 Changed editor config - image can be configured to left, right or full. há 7 anos atrás
package.json b85de4d710 Internal: Updated dependencies. [skip ci] há 7 anos atrás
webpack.config.js 550452f017 The basic implementation of the decoupled document build. há 7 anos atrás

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.

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 GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the LICENSE.md file.