Aleksander Nowodzinski 2c683418cd Used the external stylelint-config-ckeditor5 package for stylelint configuration. 6 年之前
..
.github 0e323f3688 Internal: Updated the GitHub PR template because all packages share the same issue tracker now (see ckeditor/ckeditor5#5576). 6 年之前
build 1ad82c63cd Internal: Build. 6 年之前
sample 9ad385a6b8 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. 7 年之前
src 16a041275f Feature: Enabled the indent feature in the build. 6 年之前
tests 829bfc1130 All tests require an image that exists. It will not cause the 404 error. 6 年之前
.editorconfig ef5257053c Feature: Introduced the inline editor build. 8 年之前
.eslintrc.js 6e0fedb52d Internal: Updated the license header. See ckeditor/ckeditor5#1557. [skip ci] 6 年之前
.gitattributes ef5257053c Feature: Introduced the inline editor build. 8 年之前
.gitignore 441c77346e Internal: Added "package-lock.json" to ignored files. See ckeditor/ckeditor5-build-balloon#6. 7 年之前
.stylelintrc 2c683418cd Used the external stylelint-config-ckeditor5 package for stylelint configuration. 6 年之前
.travis.yml a20a0c28e7 Internal: Upgraded CI environment to use Xenial version of the distro. See ckeditor/ckeditor#2041. 6 年之前
CHANGELOG.md 38431849bd Docs: Corrected the changelog. [skip ci] 6 年之前
CONTRIBUTING.md be175da8ff Docs: Made contributing guide link to our docs. [skip ci] 7 年之前
LICENSE.md d7a81f93ae Internal: Bumped the year. [skip ci] 6 年之前
README.md d4a8910359 Docs: Removed gitter badge. See ckeditor/ckeditor5#2037. [skip ci] 6 年之前
package.json 692d730fb0 Internal: Allowed empty input in the stylelint script to avoid errors when no files are found. Added missing stylelint-config-recommended dependency. 6 年之前
webpack.config.js e55a29f430 Bumped style-loader to v1.0.0. Aligned the webpack config to the new loader API. 6 年之前

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( 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 or https://ckeditor.com/legal/ckeditor-oss-license.