8
0
Piotrek Koszuliński bb6f495ec0 Internal: Added config for package.json to .editorconfig. See #318. 6 gadi atpakaļ
..
.github 689f3dd7d3 Internal: Updated the GitHub PR template because all packages share the same issue tracker now (see ckeditor/ckeditor5#5576). 6 gadi atpakaļ
build c9e8ea23fb Internal: Build. 6 gadi atpakaļ
sample f973214339 Minor improvements to error messages used in manual tests and a sample. [skip ci] 6 gadi atpakaļ
src c861abe912 Feature: Enabled the indent feature in the build. 6 gadi atpakaļ
tests dc5b751333 Tests: Fixed tests leaking editor instance / DOM element. 6 gadi atpakaļ
.editorconfig bb6f495ec0 Internal: Added config for package.json to .editorconfig. See #318. 6 gadi atpakaļ
.eslintrc.js b268d08178 Internal: Updated the license header. See ckeditor/ckeditor5#1557. [skip ci] 6 gadi atpakaļ
.gitattributes d9953dfe10 The initial commit. 7 gadi atpakaļ
.gitignore d9953dfe10 The initial commit. 7 gadi atpakaļ
.stylelintrc b902463868 Used the external stylelint-config-ckeditor5 package for stylelint configuration. 6 gadi atpakaļ
.travis.yml 6ced342281 Internal: Upgraded CI environment to use Xenial version of the distro. See ckeditor/ckeditor#2041. 6 gadi atpakaļ
CHANGELOG.md 4402b52878 Internal: Fixed blog post URL for the 11.0.0 release. [skip ci] 6 gadi atpakaļ
CONTRIBUTING.md 1d55567f33 Docs: Made contributing guide link to our docs. [skip ci] 7 gadi atpakaļ
LICENSE.md 696b5c0be4 Internal: Bumped the year. [skip ci] 6 gadi atpakaļ
README.md 11651d8777 Code style. [skip ci] 6 gadi atpakaļ
package.json 9deb98f7a0 Release: v16.0.0. [skip ci] 6 gadi atpakaļ
webpack.config.js 4c0ea23aa5 Replaced UglifyJS with Terser. 6 gadi atpakaļ

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( error => {
			console.error( 'There was a problem initializing the editor.', error );
		} );
</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( error => {
		console.error( 'There was a problem initializing the editor.', error );
	} );

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.