Marek Lewandowski 1069966d4a Merge branch 'monorepo-pending' 5 years ago
..
.github 0e323f3688 Internal: Updated the GitHub PR template because all packages share the same issue tracker now (see ckeditor/ckeditor5#5576). 6 years ago
build 3088faf04f Internal: Build. 5 years ago
sample 94ee5a7867 Minor improvements to error messages used in manual tests and a sample. [skip ci] 6 years ago
src 53048e0add Add TextTransformation plugin to the build config 5 years ago
tests a645bcca12 Internal: Bumped the year. [skip ci] 6 years ago
.editorconfig ded7d7818d Internal: Added config for package.json to .editorconfig. See #318. 6 years ago
.eslintrc.js a645bcca12 Internal: Bumped the year. [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
.stylelintrc 2c683418cd Used the external stylelint-config-ckeditor5 package for stylelint configuration. 6 years ago
.travis.yml 15c5ec5c6a Internal: Updated the version of Node.js on Travis. See ckeditor/ckeditor5#6542. 5 years ago
CHANGELOG.md 3cf3604bf2 Docs: Corrected the changelog. [skip ci] 5 years ago
CONTRIBUTING.md be175da8ff Docs: Made contributing guide link to our docs. [skip ci] 7 years ago
LICENSE.md a645bcca12 Internal: Bumped the year. [skip ci] 6 years ago
README.md 2019c099d2 Updated docs to monorepo state. 5 years ago
package.json 1069966d4a Merge branch 'monorepo-pending' 5 years ago
webpack.config.js e58099a6a0 Added data-cke attribute to style selector. 5 years ago

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.

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( error => {
			console.error( 'There was a problem initializing the editor.', error );
		} );
</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( error => {
		console.error( 'There was a problem initializing the editor.', error );
	} );

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.