Piotrek Koszuliński e68d6b7b71 Merge pull request #1 from ckeditor/t/ckeditor5-build-classic/23 8 年 前
..
.github ef5257053c Feature: Introduced the inline editor build. 8 年 前
bin 8cb414a439 Moved "ckeditor.js" file to "src/" directory. 8 年 前
build 6b6a7112d3 Changed the way how the build is exported, so it is available as the default export. 8 年 前
sample 78a6e4677c Docs: Improved the sample. See ckeditor/ckeditor5#535. 8 年 前
src 8cb414a439 Moved "ckeditor.js" file to "src/" directory. 8 年 前
tests 6b6a7112d3 Changed the way how the build is exported, so it is available as the default export. 8 年 前
.editorconfig ef5257053c Feature: Introduced the inline editor build. 8 年 前
.gitattributes ef5257053c Feature: Introduced the inline editor build. 8 年 前
.gitignore ef5257053c Feature: Introduced the inline editor build. 8 年 前
CHANGELOG.md de11e4e188 Docs: Changelog. [skip ci] 8 年 前
CONTRIBUTING.md ef5257053c Feature: Introduced the inline editor build. 8 年 前
LICENSE.md ef5257053c Feature: Introduced the inline editor build. 8 年 前
README.md e4f039be43 Docs: Improved editors and builds docs. 8 年 前
build-config.js 6e66d587ee Internal: The ckeditor5-presets became ckeditor5-essentials. See ckeditor/ckeditor5-essentials#1. 8 年 前
package.json e68d6b7b71 Merge pull request #1 from ckeditor/t/ckeditor5-build-classic/23 8 年 前
webpack.config.js 8cb414a439 Moved "ckeditor.js" file to "src/" directory. 8 年 前

README.md

CKEditor 5 inline editor build

npm version Dependency Status devDependency Status

The inline editor build. 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.