Marek Lewandowski 2265cf812a Merge branch 'monorepo-pending' 5 years ago
..
.github 689f3dd7d3 Internal: Updated the GitHub PR template because all packages share the same issue tracker now (see ckeditor/ckeditor5#5576). 6 years ago
build 79a4653267 Internal: Build. 5 years ago
sample 2a3cc9c863 All features should be visible by default. 5 years ago
src 672de3a669 Add TextTransformation plugin to the build config 5 years ago
tests e2c83bf391 Use a typical value that would be applied by this feature. 5 years ago
.editorconfig bb6f495ec0 Internal: Added config for package.json to .editorconfig. See #318. 6 years ago
.eslintrc.js bb3b88332f Internal: Bumped the year. [skip ci] 6 years ago
.gitattributes d9953dfe10 The initial commit. 7 years ago
.gitignore d9953dfe10 The initial commit. 7 years ago
.stylelintrc b902463868 Used the external stylelint-config-ckeditor5 package for stylelint configuration. 6 years ago
.travis.yml 9ffd8d4d0d Internal: Updated the version of Node.js on Travis. See ckeditor/ckeditor5#6542. 5 years ago
CHANGELOG.md ae599e25ee Docs: Corrected the changelog. [skip ci] 5 years ago
CONTRIBUTING.md 1d55567f33 Docs: Made contributing guide link to our docs. [skip ci] 7 years ago
LICENSE.md bb3b88332f Internal: Bumped the year. [skip ci] 6 years ago
README.md 4b5cda7951 Updated docs to monorepo state. 5 years ago
package.json 2265cf812a Merge branch 'monorepo-pending' 5 years ago
webpack.config.js f68e644789 Added data-cke attribute to style selector. 5 years ago

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.

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.