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

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.