Piotrek Koszuliński d7d9467a89 Release: v1.0.0-beta.4. 7 年之前
..
.github 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 年之前
bin 9d26c2e86f Internal: Bumped the year. [skip ci] 8 年之前
build 5f7ddbcdce Internal: Build. 7 年之前
sample f17787ba75 Internal: Updated links to CKEditor 5 website. [skip ci] 7 年之前
src 1841d92b06 Removed duplicated "ImageUpload" plugin. 7 年之前
tests f17787ba75 Internal: Updated links to CKEditor 5 website. [skip ci] 7 年之前
.editorconfig 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 年之前
.gitattributes 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 年之前
.gitignore 32fd78aace Internal: Added "package-lock.json" to ignored files. Closes #6. 8 年之前
CHANGELOG.md 791d49b300 Docs: Changelog. [skip ci] 7 年之前
CONTRIBUTING.md 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 年之前
LICENSE.md 9cebdfe3f8 Internal: Improved license file. 7 年之前
README.md 9e3532d3e1 Merge branch 'stable' 7 年之前
build-config.js 1841d92b06 Removed duplicated "ImageUpload" plugin. 7 年之前
package.json d7d9467a89 Release: v1.0.0-beta.4. 7 年之前
webpack.config.js 84f25cf775 Other: Unify `getPostCssConfig()` from @ckeditor/ckeditor5-dev-utils package. 7 年之前

README.md

CKEditor 5 balloon editor build

npm version Dependency Status devDependency Status

The balloon editor build for CKEditor 5. Read more about the balloon editor build and see the demo.

Documentation

See:

Quick start

First, install the build from npm:

npm install --save @ckeditor/ckeditor5-build-balloon

And use it in your website:

<div id="editor">
	<p>This is the editor content.</p>
</div>
<script src="./node_modules/@ckeditor/ckeditor5-build-balloon/build/ckeditor.js"></script>
<script>
	BalloonEditor
		.create( document.querySelector( '#editor' ) )
		.then( editor => {
			window.editor = editor;
		} )
		.catch( err => {
			console.error( err.stack );
		} );
</script>

Or in your JavaScript application:

import BalloonEditor from '@ckeditor/ckeditor5-build-balloon';

// Or using the CommonJS version:
// const BalloonEditor = require( '@ckeditor/ckeditor5-build-balloon' );

BalloonEditor
	.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 GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the LICENSE.md file.