Aleksander Nowodzinski ead3adf4d0 Internal: Build. před 5 roky
..
.github 0e323f3688 Internal: Updated the GitHub PR template because all packages share the same issue tracker now (see ckeditor/ckeditor5#5576). před 6 roky
build ead3adf4d0 Internal: Build. před 5 roky
sample 94ee5a7867 Minor improvements to error messages used in manual tests and a sample. [skip ci] před 6 roky
src 53048e0add Add TextTransformation plugin to the build config před 5 roky
tests a645bcca12 Internal: Bumped the year. [skip ci] před 6 roky
.editorconfig ded7d7818d Internal: Added config for package.json to .editorconfig. See #318. před 6 roky
.eslintrc.js a645bcca12 Internal: Bumped the year. [skip ci] před 6 roky
.gitattributes ef5257053c Feature: Introduced the inline editor build. před 8 roky
.gitignore 441c77346e Internal: Added "package-lock.json" to ignored files. See ckeditor/ckeditor5-build-balloon#6. před 8 roky
.stylelintrc 2c683418cd Used the external stylelint-config-ckeditor5 package for stylelint configuration. před 6 roky
.travis.yml a20a0c28e7 Internal: Upgraded CI environment to use Xenial version of the distro. See ckeditor/ckeditor#2041. před 6 roky
CHANGELOG.md a037ef2c27 Docs: Version 17.0.0 blog post links arrived! před 5 roky
CONTRIBUTING.md be175da8ff Docs: Made contributing guide link to our docs. [skip ci] před 7 roky
LICENSE.md a645bcca12 Internal: Bumped the year. [skip ci] před 6 roky
README.md 94ee5a7867 Minor improvements to error messages used in manual tests and a sample. [skip ci] před 6 roky
package.json 53048e0add Add TextTransformation plugin to the build config před 5 roky
webpack.config.js 87759b033e Fix dangling comma. před 5 roky

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