Kamil Piechaczek ae3475b6c4 Merge branch 'master' into t/ckeditor5/724 7 anni fa
..
.github ef5257053c Feature: Introduced the inline editor build. 8 anni fa
bin 199ba318d1 Internal: Bumped the year. [skip ci] 8 anni fa
build 571daf692a Renamed build/lang to build/translations. 7 anni fa
sample c50f619ac3 Docs: Updated links with anchors. See ckeditor/ckeditor5#826. [skip ci] 7 anni fa
src 3e2c5f632c Other: Rename ImageStyle options, UI components and merge commands into one command. 7 anni fa
tests 199ba318d1 Internal: Bumped the year. [skip ci] 8 anni fa
.editorconfig ef5257053c Feature: Introduced the inline editor build. 8 anni fa
.gitattributes ef5257053c Feature: Introduced the inline editor build. 8 anni fa
.gitignore 441c77346e Internal: Added "package-lock.json" to ignored files. See ckeditor/ckeditor5-build-balloon#6. 8 anni fa
CHANGELOG.md 951f5c6736 Docs: Fixed links in the changelog. [skip ci] 8 anni fa
CONTRIBUTING.md ef5257053c Feature: Introduced the inline editor build. 8 anni fa
LICENSE.md 199ba318d1 Internal: Bumped the year. [skip ci] 8 anni fa
README.md c50f619ac3 Docs: Updated links with anchors. See ckeditor/ckeditor5#826. [skip ci] 7 anni fa
build-config.js 3e2c5f632c Other: Rename ImageStyle options, UI components and merge commands into one command. 7 anni fa
package.json ec2f79a17d Internal: Updated babel-minify-webpack-plugin. 7 anni fa
webpack.config.js 3590dc8fb7 Other: Unify `getPostCssConfig()` from @ckeditor/ckeditor5-dev-utils package. 7 anni fa

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.