Maciej Bukowski f9020f9250 Aligned build to the new Translation Service. 8 years ago
..
.github ef5257053c Feature: Introduced the inline editor build. 8 years ago
bin 8cb414a439 Moved "ckeditor.js" file to "src/" directory. 8 years ago
build f9020f9250 Aligned build to the new Translation Service. 8 years ago
sample 78a6e4677c Docs: Improved the sample. See ckeditor/ckeditor5#535. 8 years ago
src f9020f9250 Aligned build to the new Translation Service. 8 years ago
tests 98266c2f79 Tests: Fixed tests after recent dir structure changes. 8 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 017bdc8aef Internal: Removed outdated comment. 8 years ago
CHANGELOG.md 951f5c6736 Docs: Fixed links in the changelog. [skip ci] 8 years ago
CONTRIBUTING.md ef5257053c Feature: Introduced the inline editor build. 8 years ago
LICENSE.md ef5257053c Feature: Introduced the inline editor build. 8 years ago
README.md deefd0aa5c Docs: README page corrected. [skip ci] 8 years ago
build-config.js f9020f9250 Aligned build to the new Translation Service. 8 years ago
package.json 43189c6d39 Release: v1.0.0-alpha.2. 8 years ago
webpack.config.js f9020f9250 Aligned build to the new Translation Service. 8 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 CommonJS verion:
// 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 GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the LICENSE.md file.