Piotrek Koszuliński 105b50cade Internal: Updated dependencies. [skip ci] 6 tahun lalu
..
.github ef5257053c Feature: Introduced the inline editor build. 8 tahun lalu
build 1af4df7bbd Internal: Build. 6 tahun lalu
sample 9ad385a6b8 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. 7 tahun lalu
src d7a81f93ae Internal: Bumped the year. [skip ci] 7 tahun lalu
tests d7a81f93ae Internal: Bumped the year. [skip ci] 7 tahun lalu
.editorconfig ef5257053c Feature: Introduced the inline editor build. 8 tahun lalu
.eslintrc.js d7a81f93ae Internal: Bumped the year. [skip ci] 7 tahun lalu
.gitattributes ef5257053c Feature: Introduced the inline editor build. 8 tahun lalu
.gitignore 441c77346e Internal: Added "package-lock.json" to ignored files. See ckeditor/ckeditor5-build-balloon#6. 8 tahun lalu
.travis.yml 64acee2c26 Fixed formatting in Travis configuration file. 7 tahun lalu
CHANGELOG.md f22b1c2508 Docs: Corrected the changelog. [skip ci] 6 tahun lalu
CONTRIBUTING.md be175da8ff Docs: Made contributing guide link to our docs. [skip ci] 7 tahun lalu
LICENSE.md d7a81f93ae Internal: Bumped the year. [skip ci] 7 tahun lalu
README.md b6a7b22030 Docs: Added build status badges to the README. See: ckeditor/ckeditor5#1236. 7 tahun lalu
package.json 105b50cade Internal: Updated dependencies. [skip ci] 6 tahun lalu
webpack.config.js d7a81f93ae Internal: Bumped the year. [skip ci] 7 tahun lalu

README.md

CKEditor 5 inline editor build

npm version Build Status BrowserStack 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( 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.