Piotrek Koszuliński dc15692fbb Docs: Improved keywords and the readme. [skip ci] 7 jaren geleden
..
.github ef5257053c Feature: Introduced the inline editor build. 8 jaren geleden
bin 015d408861 Switched to webpack@4.12 and UglifyJsWebpackPlugin. 7 jaren geleden
build 2ce89706ac Changed RegExp for preserved comments. 7 jaren geleden
sample 96a36d2df1 Internal: Updated links to CKEditor 5 website. [skip ci] 7 jaren geleden
src 46b2d161ac Removed duplicated "ImageUpload" plugin. 7 jaren geleden
tests 96a36d2df1 Internal: Updated links to CKEditor 5 website. [skip ci] 7 jaren geleden
.editorconfig ef5257053c Feature: Introduced the inline editor build. 8 jaren geleden
.gitattributes ef5257053c Feature: Introduced the inline editor build. 8 jaren geleden
.gitignore 441c77346e Internal: Added "package-lock.json" to ignored files. See ckeditor/ckeditor5-build-balloon#6. 8 jaren geleden
CHANGELOG.md 9cd8ee4ee7 Docs: Corrected the changelog. [skip ci] 7 jaren geleden
CONTRIBUTING.md ef5257053c Feature: Introduced the inline editor build. 8 jaren geleden
LICENSE.md 78b96d7988 Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. 7 jaren geleden
README.md 78b96d7988 Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. 7 jaren geleden
build-config.js 46b2d161ac Removed duplicated "ImageUpload" plugin. 7 jaren geleden
package.json dc15692fbb Docs: Improved keywords and the readme. [skip ci] 7 jaren geleden
webpack.config.js 694cc44763 Improved comments. 7 jaren geleden

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 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.