Piotrek Koszuliński 4a327c1746 Docs: Changelog. [skip ci] 6 年之前
..
.github 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 年之前
build fa44f36621 Internal: Build. 6 年之前
sample 3c4395f2b1 Docs: Changed links to documentation. See ckeditor/ckeditor5#1192. 7 年之前
src abb0740ceb Internal: Bumped the year. [skip ci] 6 年之前
tests abb0740ceb Internal: Bumped the year. [skip ci] 6 年之前
.editorconfig 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 年之前
.eslintrc.js abb0740ceb Internal: Bumped the year. [skip ci] 6 年之前
.gitattributes 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. 8 年之前
.gitignore 32fd78aace Internal: Added "package-lock.json" to ignored files. Closes #6. 7 年之前
.travis.yml aef38795d1 Fixed formatting in Travis configuration file. 7 年之前
CHANGELOG.md 4a327c1746 Docs: Changelog. [skip ci] 6 年之前
CONTRIBUTING.md 7db1df5d22 Docs: Made contributing guide link to our docs. [skip ci] 7 年之前
LICENSE.md abb0740ceb Internal: Bumped the year. [skip ci] 6 年之前
README.md 571f8bc857 Docs: Added build status badges to the README. See: ckeditor/ckeditor5#1236. 7 年之前
package.json 3f405dd9d4 Internal: Removed unnecessary and added missing deps. 6 年之前
webpack.config.js abb0740ceb Internal: Bumped the year. [skip ci] 6 年之前

README.md

CKEditor 5 balloon editor build

npm version Build Status BrowserStack Status
Dependency Status devDependency Status

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

CKEditor 5 balloon editor build screenshot

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 terms of GNU General Public License Version 2 or later. For full details about the license, please check the LICENSE.md file.