Aleksander Nowodzinski bb6556e424 Internal: Build. 5 年之前
..
.github 689f3dd7d3 Internal: Updated the GitHub PR template because all packages share the same issue tracker now (see ckeditor/ckeditor5#5576). 6 年之前
build bb6556e424 Internal: Build. 5 年之前
sample 2a3cc9c863 All features should be visible by default. 5 年之前
src 672de3a669 Add TextTransformation plugin to the build config 5 年之前
tests e2c83bf391 Use a typical value that would be applied by this feature. 5 年之前
.editorconfig bb6f495ec0 Internal: Added config for package.json to .editorconfig. See #318. 6 年之前
.eslintrc.js bb3b88332f Internal: Bumped the year. [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 8237331508 Docs: Version 17.0.0 blog post links arrived! 5 年之前
CONTRIBUTING.md 1d55567f33 Docs: Made contributing guide link to our docs. [skip ci] 7 年之前
LICENSE.md bb3b88332f Internal: Bumped the year. [skip ci] 6 年之前
README.md 11651d8777 Code style. [skip ci] 6 年之前
package.json 672de3a669 Add TextTransformation plugin to the build config 5 年之前
webpack.config.js 159aac9538 Fix dangling comma. 5 年之前

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.