Piotrek Koszuliński 9babe3408a Other: Changed the order of buttons in the image toolbar. See https://github.com/ckeditor/ckeditor5-image/issues/60. 8 年之前
..
bin 609c0093f2 Moved Webpack configs to this repository for simpler tinkering with them. 8 年之前
build ab7a36fda3 Other: Updated the bundles (the previous release contained an outdated bundles). 8 年之前
sample 5df2f4655a Minor improvement in tests. 8 年之前
tests b423d5131c Note in the manual tests that they need the bundles to be rebuilt. 8 年之前
.editorconfig f5f6466a64 Initial commit. 8 年之前
.gitattributes a71f36861c Various improvements. 8 年之前
.gitignore a71f36861c Various improvements. 8 年之前
.npmignore b2d103542a Added dot files. 8 年之前
CHANGELOG.md b2042b2a1a Docs: Changelog entry. 8 年之前
CONTRIBUTING.md a71f36861c Various improvements. 8 年之前
LICENSE.md a71f36861c Various improvements. 8 年之前
README.md 1bbeb9a83e Docs: Improved the mention of babel-preset-env in the readme. 8 年之前
ckeditor.js b423d5131c Note in the manual tests that they need the bundles to be rebuilt. 8 年之前
config-build.js b423d5131c Note in the manual tests that they need the bundles to be rebuilt. 8 年之前
config-editor.js 9babe3408a Other: Changed the order of buttons in the image toolbar. See https://github.com/ckeditor/ckeditor5-image/issues/60. 8 年之前
package.json a38d6e107e 0.1.1 8 年之前
webpack.compat.config.js 609c0093f2 Moved Webpack configs to this repository for simpler tinkering with them. 8 年之前
webpack.config.js 609c0093f2 Moved Webpack configs to this repository for simpler tinkering with them. 8 年之前

README.md

CKEditor 5 classic build

npm version Dependency Status devDependency Status

Classic build of CKEditor 5. Features the classic creator and the standard set of article features.

Bundles

The package contain two bundles of the classic editor:

  • build/ckeditor.js – minified, ES6 version of the bundle,
  • build/ckeditor.compat.js – minified, backward-compatible version of the bundle (babel-preset-env is configured to support 'last 2 versions', 'ie >= 11').

Usage

First, install the build from npm:

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

And use it in your website:

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

Or in your JavaScript application:

import { ClassicEditor } from '@ckeditor/ckeditor5-build-classic/build/ckeditor';

// or using CommonJS verion:
// const ClassicEditor = require( '@ckeditor/ckeditor5-build-classic/build/ckeditor' ).ClassicEditor;

ClassicEditor.create( document.querySelector( '#editor' ) )
	.then( editor => {
		window.editor = editor;
	} )
	.catch( err => {
		console.error( err.stack );
	} );

Note: If you're planning to integrate CKEditor 5 deep into your application it's actually more convenient and recommended to install and import the source modules directly (like it happens in ckeditor.js).

Rebuilding the bundle

Note: This section assumes that you cloned this package repository and execute the commands inside it.

You can modify config-editor.js, config-build.js or any of the Webpack configs and run:

npm run build

To rebuild the entry-point (ckeditor.js) and both builds (build/*).

You can also modify ckeditor.js directly and run one of npm run build-ckeditor or npm run build-ckeditor-compat.

License

Licensed under the GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the LICENSE.md file.