Kamil Piechaczek b6a7b22030 Docs: Added build status badges to the README. See: ckeditor/ckeditor5#1236. hace 7 años
..
.github ef5257053c Feature: Introduced the inline editor build. hace 8 años
build 4c56b7e8f7 Internal: Build. hace 7 años
sample 9ad385a6b8 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. hace 7 años
src f4184ad428 Feature: Introduced the CKFinder integration plugin. hace 7 años
tests 997c59f5ac Code style in tests. hace 7 años
.editorconfig ef5257053c Feature: Introduced the inline editor build. hace 8 años
.eslintrc.js 71578a7eb3 Added a configuration for ESLint. hace 7 años
.gitattributes ef5257053c Feature: Introduced the inline editor build. hace 8 años
.gitignore 441c77346e Internal: Added "package-lock.json" to ignored files. See ckeditor/ckeditor5-build-balloon#6. hace 7 años
.travis.yml db319b6aeb Introduced a linter and Travis. hace 7 años
CHANGELOG.md f39ca06937 Docs: Corrected the changelog. [skip ci] hace 7 años
CONTRIBUTING.md be175da8ff Docs: Made contributing guide link to our docs. [skip ci] hace 7 años
LICENSE.md 78b96d7988 Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. hace 7 años
README.md b6a7b22030 Docs: Added build status badges to the README. See: ckeditor/ckeditor5#1236. hace 7 años
package.json 76971e7b8a Merge branch 'master' into t/ckeditor5/1236 hace 7 años
webpack.config.js be8ca17e7f Removed unnecessary comment in `webpack.config.js`. hace 7 años

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.