Piotrek Koszuliński 30bd6efdca Release: v12.4.0. [skip ci] 6 years ago
..
.github ef5257053c Feature: Introduced the inline editor build. 8 years ago
build 3c64befc9d Internal: Build. 6 years ago
sample 9ad385a6b8 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. 7 years ago
src 6e0fedb52d Internal: Updated the license header. See ckeditor/ckeditor5#1557. [skip ci] 6 years ago
tests 829bfc1130 All tests require an image that exists. It will not cause the 404 error. 6 years ago
.editorconfig ef5257053c Feature: Introduced the inline editor build. 8 years ago
.eslintrc.js 6e0fedb52d Internal: Updated the license header. See ckeditor/ckeditor5#1557. [skip ci] 6 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
.travis.yml a1a33a3bbf Removed BrowserStack from the repository. 6 years ago
CHANGELOG.md 3a2b675d2a Docs: Corrected the changelog. [skip ci] 6 years ago
CONTRIBUTING.md be175da8ff Docs: Made contributing guide link to our docs. [skip ci] 7 years ago
LICENSE.md d7a81f93ae Internal: Bumped the year. [skip ci] 6 years ago
README.md a1a33a3bbf Removed BrowserStack from the repository. 6 years ago
package.json 30bd6efdca Release: v12.4.0. [skip ci] 6 years ago
webpack.config.js e55a29f430 Bumped style-loader to v1.0.0. Aligned the webpack config to the new loader API. 6 years ago

README.md

CKEditor 5 inline editor build

npm version Build Status
Dependency Status devDependency Status

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

CKEditor 5 inline editor build screenshot

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 or https://ckeditor.com/legal/ckeditor-oss-license.