Piotrek Koszuliński 49c9a7be55 Merge branch 'master' into i/1353 преди 6 години
..
.github 689f3dd7d3 Internal: Updated the GitHub PR template because all packages share the same issue tracker now (see ckeditor/ckeditor5#5576). преди 6 години
build a0093ced44 Internal: Build. преди 6 години
sample e472546255 Internal: The demo should fit. преди 7 години
src c861abe912 Feature: Enabled the indent feature in the build. преди 6 години
tests e1a27ab4b2 All tests require an image that exists. It will not cause the 404 error. преди 6 години
.editorconfig d9953dfe10 The initial commit. преди 7 години
.eslintrc.js b268d08178 Internal: Updated the license header. See ckeditor/ckeditor5#1557. [skip ci] преди 6 години
.gitattributes d9953dfe10 The initial commit. преди 7 години
.gitignore d9953dfe10 The initial commit. преди 7 години
.stylelintrc b902463868 Used the external stylelint-config-ckeditor5 package for stylelint configuration. преди 6 години
.travis.yml 6ced342281 Internal: Upgraded CI environment to use Xenial version of the distro. See ckeditor/ckeditor#2041. преди 6 години
CHANGELOG.md 973dc7ca16 Docs: Corrected the changelog. [skip ci] преди 6 години
CONTRIBUTING.md 1d55567f33 Docs: Made contributing guide link to our docs. [skip ci] преди 7 години
LICENSE.md 696b5c0be4 Internal: Bumped the year. [skip ci] преди 6 години
README.md 1c23295df9 Docs: Fixed code listing in the README.md. преди 6 години
package.json 49c9a7be55 Merge branch 'master' into i/1353 преди 6 години
webpack.config.js 4c0ea23aa5 Replaced UglifyJS with Terser. преди 6 години

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.