Kamil Piechaczek 3aae4cc54e Merge pull request #8 from ckeditor/t/ckeditor5/724 7 lat temu
..
.github ef5257053c Feature: Introduced the inline editor build. 8 lat temu
bin 199ba318d1 Internal: Bumped the year. [skip ci] 8 lat temu
build 4b70081770 Feature: Added the image upload button to the build. See ckeditor/ckeditor5#870. 7 lat temu
sample c50f619ac3 Docs: Updated links with anchors. See ckeditor/ckeditor5#826. [skip ci] 7 lat temu
src 4b70081770 Feature: Added the image upload button to the build. See ckeditor/ckeditor5#870. 7 lat temu
tests 199ba318d1 Internal: Bumped the year. [skip ci] 8 lat temu
.editorconfig ef5257053c Feature: Introduced the inline editor build. 8 lat temu
.gitattributes ef5257053c Feature: Introduced the inline editor build. 8 lat temu
.gitignore 441c77346e Internal: Added "package-lock.json" to ignored files. See ckeditor/ckeditor5-build-balloon#6. 7 lat temu
CHANGELOG.md 951f5c6736 Docs: Fixed links in the changelog. [skip ci] 8 lat temu
CONTRIBUTING.md ef5257053c Feature: Introduced the inline editor build. 8 lat temu
LICENSE.md 199ba318d1 Internal: Bumped the year. [skip ci] 8 lat temu
README.md c50f619ac3 Docs: Updated links with anchors. See ckeditor/ckeditor5#826. [skip ci] 7 lat temu
build-config.js 4b70081770 Feature: Added the image upload button to the build. See ckeditor/ckeditor5#870. 7 lat temu
package.json ec2f79a17d Internal: Updated babel-minify-webpack-plugin. 7 lat temu
webpack.config.js 3590dc8fb7 Other: Unify `getPostCssConfig()` from @ckeditor/ckeditor5-dev-utils package. 7 lat temu

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.