Piotrek Koszuliński db05885cd5 Internal: uploadImage is now called imageUpload. 7 年之前
..
.github d9953dfe10 The initial commit. 7 年之前
bin 550452f017 The basic implementation of the decoupled document build. 7 年之前
build db05885cd5 Internal: uploadImage is now called imageUpload. 7 年之前
sample 073e862f46 Docs: Updated package docs. 7 年之前
src db05885cd5 Internal: uploadImage is now called imageUpload. 7 年之前
tests aeb3a18269 Tests: Added missing feature tests. 7 年之前
.editorconfig d9953dfe10 The initial commit. 7 年之前
.gitattributes d9953dfe10 The initial commit. 7 年之前
.gitignore d9953dfe10 The initial commit. 7 年之前
CONTRIBUTING.md 550452f017 The basic implementation of the decoupled document build. 7 年之前
LICENSE.md ec5d419f95 Let's call it a document editor build for now (until we have more document builds). 7 年之前
README.md 073e862f46 Docs: Updated package docs. 7 年之前
build-config.js db05885cd5 Internal: uploadImage is now called imageUpload. 7 年之前
package.json abe6c642df Pre-release should be 0.0.1. 7 年之前
webpack.config.js 550452f017 The basic implementation of the decoupled document build. 7 年之前

README.md

CKEditor 5 decoupled document build

npm version Dependency Status devDependency Status

The decoupled document build for CKEditor 5. Read more about the [decoupled document build]((https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/builds/guides/overview.html#document-editor) 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>
	DecoupledDocumentEditor
		.create( '<h2>Hello world!</h2>', {
			toolbarContainer: '.toolbar-container',
			editableContainer: '.editable-container'
		} )
		.then( editor => {
			window.editor = editor;
		} )
		.catch( err => {
			console.error( err.stack );
		} );
</script>

Or in your JavaScript application:

import DecoupledDocumentEditor from '@ckeditor/ckeditor5-build-decoupled-document';

// Or using CommonJS verion:
// const DecoupledDocumentEditor = require( '@ckeditor/ckeditor5-build-decoupled-document' );

DecoupledDocumentEditor
	.create( '<h2>Hello world!</h2>', {
			toolbarContainer: '.toolbar-container',
			editableContainer: '.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 GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the LICENSE.md file.