Piotrek Koszuliński 78b96d7988 Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. 7 年 前
..
.github ef5257053c Feature: Introduced the inline editor build. 8 年 前
bin 199ba318d1 Internal: Bumped the year. [skip ci] 8 年 前
build a6476f6466 Internal: Build. 7 年 前
sample 96a36d2df1 Internal: Updated links to CKEditor 5 website. [skip ci] 7 年 前
src 46b2d161ac Removed duplicated "ImageUpload" plugin. 7 年 前
tests 96a36d2df1 Internal: Updated links to CKEditor 5 website. [skip ci] 7 年 前
.editorconfig ef5257053c Feature: Introduced the inline editor build. 8 年 前
.gitattributes ef5257053c Feature: Introduced the inline editor build. 8 年 前
.gitignore 441c77346e Internal: Added "package-lock.json" to ignored files. See ckeditor/ckeditor5-build-balloon#6. 7 年 前
CHANGELOG.md 1c563820c2 Docs: Changelog. [skip ci] 7 年 前
CONTRIBUTING.md ef5257053c Feature: Introduced the inline editor build. 8 年 前
LICENSE.md 78b96d7988 Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. 7 年 前
README.md 78b96d7988 Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. 7 年 前
build-config.js 46b2d161ac Removed duplicated "ImageUpload" plugin. 7 年 前
package.json 78b96d7988 Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. 7 年 前
webpack.config.js 3590dc8fb7 Other: Unify `getPostCssConfig()` from @ckeditor/ckeditor5-dev-utils package. 7 年 前

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.