No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
build
src
tests
.editorconfig
.gitattributes
.gitignore
CHANGELOG.md
CONTRIBUTING.md
LICENSE.md
README.md
build-config.js
package-lock.json
package.json
webpack.config.js

README.md

CKEditor 5 classic editor build

Join the chat at https://gitter.im/ckeditor/ckeditor5 npm version Dependency Status devDependency Status

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

Documentation

See:

Quick start

First, install the build from npm:

npm install --save ckeditor5-custom

And use it in your website:

<div id="editor">
	<p>This is the editor content.</p>
</div>
<script src="./node_modules/ckeditor5-custom/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 'ckeditor5-custom';

// Or using CommonJS verion:
// const ClassicEditor = require( 'ckeditor5-custom' );

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

config like:

const ck_config = { toolbar: [ 'headings', 'bold', 'italic', 'underline', 'link', 'code', 'bulletedList', 'numberedList','blockQuote','insertImage', '|', 'alignLeft','alignCenter','alignRight', 'alignJustify','|','undo', 'redo'], heading: { options: [ { modelElement: 'paragraph', title: '段落', class: 'ck-heading_paragraph' }, { modelElement: 'heading1', viewElement: 'h2', title: '标题 1', class: 'ck-heading_heading1' }, { modelElement: 'heading2', viewElement: 'h3', title: '标题 2', class: 'ck-heading_heading2' }, { modelElement: 'heading3', viewElement: 'h4', title: '标题 3', class: 'ck-heading_heading3' } ] }, image: { toolbar: [ 'imageTextAlternative', '|', 'imageStyleFull', 'imageStyleAlignLeft', 'imageStyleAlignCenter', 'imageStyleAlignRight' ], styles: [ 'imageStyleFull', 'imageStyleAlignLeft', 'imageStyleAlignCenter', 'imageStyleAlignRight' ] }, alignment: { styles:['left','center','right', 'justify'] }, ckfinder: { uploadUrl: } }

then you can use config to create you own application: ClassicEditor .create( document.querySelector( '#editor' ) , ck_config ) .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.