Kamil Piechaczek 441c77346e Internal: Added "package-lock.json" to ignored files. See ckeditor/ckeditor5-build-balloon#6. 7 years ago
..
.github ef5257053c Feature: Introduced the inline editor build. 8 years ago
bin 199ba318d1 Internal: Bumped the year. [skip ci] 8 years ago
build 199ba318d1 Internal: Bumped the year. [skip ci] 8 years ago
sample 78a6e4677c Docs: Improved the sample. See ckeditor/ckeditor5#535. 8 years ago
src a9489cbc49 Merge branch 'master' into t/ckeditor5/645 7 years ago
tests 199ba318d1 Internal: Bumped the year. [skip ci] 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 441c77346e Internal: Added "package-lock.json" to ignored files. See ckeditor/ckeditor5-build-balloon#6. 7 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 199ba318d1 Internal: Bumped the year. [skip ci] 8 years ago
README.md deefd0aa5c Docs: README page corrected. [skip ci] 8 years ago
build-config.js a9489cbc49 Merge branch 'master' into t/ckeditor5/645 7 years ago
package.json 5bd7d64a5a Internal: Downgraded webpack-sources because https://github.com/ckeditor/ckeditor5/issues/658 is still a problem. 8 years ago
webpack.config.js 199ba318d1 Internal: Bumped the year. [skip ci] 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.