Maciej Bukowski b362faa1a9 Switched back to banner with exclamation mark. 7 年 前
..
.github d9953dfe10 The initial commit. 7 年 前
bin 0bce500443 Switched to webpack@4.12 and UglifyJsWebpackPlugin. 7 年 前
build 0f71d53a6d Changed RegExp for preserved comments. 7 年 前
sample 4c7476bb39 Docs: Fix nested editable styles in document editor sample. 7 年 前
src 256e9dbbf0 Internal: Aligned button names to changes in ckeditor5-table. 7 年 前
tests 10e25a3475 Added the table feature to the build. 7 年 前
.editorconfig d9953dfe10 The initial commit. 7 年 前
.gitattributes d9953dfe10 The initial commit. 7 年 前
.gitignore d9953dfe10 The initial commit. 7 年 前
CHANGELOG.md ba96955c57 Docs: Corrected the changelog. [skip ci] 7 年 前
CONTRIBUTING.md 550452f017 The basic implementation of the decoupled document build. 7 年 前
LICENSE.md 219b1dc60c Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. 7 年 前
README.md 219b1dc60c Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. 7 年 前
build-config.js 256e9dbbf0 Internal: Aligned button names to changes in ckeditor5-table. 7 年 前
package.json 0bce500443 Switched to webpack@4.12 and UglifyJsWebpackPlugin. 7 年 前
webpack.config.js b362faa1a9 Switched back to banner with exclamation mark. 7 年 前

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 terms of GNU General Public License Version 2 or later. For full details about the license, please check the LICENSE.md file.