Kamil Piechaczek 9ad385a6b8 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. 7 years ago
..
.github ef5257053c Feature: Introduced the inline editor build. 8 years ago
build 675e853e58 Internal: Build. 7 years ago
sample 9ad385a6b8 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. 7 years ago
src d9b15d8bff Internal: Further builds simplifications plus some comments. 7 years ago
tests d80434e57a Internal: Aligned code to changes in ckeditor5-core. See ckeditor/ckeditor5-core#140. 7 years ago
.editorconfig ef5257053c Feature: Introduced the inline editor build. 8 years ago
.gitattributes ef5257053c Feature: Introduced the inline editor build. 8 years ago
.gitignore 441c77346e Internal: Added "package-lock.json" to ignored files. See ckeditor/ckeditor5-build-balloon#6. 7 years ago
CHANGELOG.md 9ad385a6b8 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. 7 years ago
CONTRIBUTING.md ef5257053c Feature: Introduced the inline editor build. 8 years ago
LICENSE.md 78b96d7988 Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. 7 years ago
README.md 9ad385a6b8 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. 7 years ago
package.json f70e8e92ec Release: v11.0.1. 7 years ago
webpack.config.js be8ca17e7f Removed unnecessary comment in `webpack.config.js`. 7 years ago

README.md

CKEditor 5 inline editor build

npm version Dependency Status devDependency Status

The inline editor build for CKEditor 5. Read more about the inline editor build and see the demo.

Documentation

See:

Quick start

First, install the build from npm:

npm install --save @ckeditor/ckeditor5-build-inline

And use it in your website:

<div id="editor">
	<p>This is the editor content.</p>
</div>
<script src="./node_modules/@ckeditor/ckeditor5-build-inline/build/ckeditor.js"></script>
<script>
	InlineEditor
		.create( document.querySelector( '#editor' ) )
		.then( editor => {
			window.editor = editor;
		} )
		.catch( err => {
			console.error( err.stack );
		} );
</script>

Or in your JavaScript application:

import InlineEditor from '@ckeditor/ckeditor5-build-inline';

// Or using the CommonJS version:
// const InlineEditor = require( '@ckeditor/ckeditor5-build-inline' );

InlineEditor
	.create( document.querySelector( '#editor' ) )
	.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.