Maciej Bukowski 441305ff4f Removed unnecessary comment in `webpack.config.js`. hace 7 años
..
.github 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. hace 8 años
build 35a0f24bbd Internal: Build. hace 7 años
sample f17787ba75 Internal: Updated links to CKEditor 5 website. [skip ci] hace 7 años
src 0c8cbe1bd6 Other: Changed the build structure. TODO. Closes ckeditor/ckeditor5#1038. hace 7 años
tests 5a1af53594 Internal: Aligned code to changes in ckeditor5-core. See ckeditor/ckeditor5-core#140. hace 7 años
.editorconfig 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. hace 8 años
.gitattributes 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. hace 8 años
.gitignore 32fd78aace Internal: Added "package-lock.json" to ignored files. Closes #6. hace 8 años
CHANGELOG.md 936a4b8000 Docs: Corrected the changelog. [skip ci] hace 7 años
CONTRIBUTING.md 04fd4d53f8 Feature: Introduced the editor with a balloon toolbar build. hace 8 años
LICENSE.md 7ee9a6acb1 Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. hace 7 años
README.md 7ee9a6acb1 Other: Changed the license to GPL2+ only. See ckeditor/ckeditor5#991. hace 7 años
package.json 0c8cbe1bd6 Other: Changed the build structure. TODO. Closes ckeditor/ckeditor5#1038. hace 7 años
webpack.config.js 441305ff4f Removed unnecessary comment in `webpack.config.js`. hace 7 años

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