CKEditor 5 standard build based on ckeditor5 build classic
The standard editor build for CKEditor 5 based on ckeditor5 build classic. Read more about the classic editor build and see the demo.
Check source code on GitHub for what this standard build contains.
Documentation
See:
- Installation for how to install this package and what it contains.
- Basic API for how to create an editor and interact with it.
- Configuration for how to configure the editor.
- Creating custom builds for how to customize the build (configure and rebuild the editor bundle).
Quick start
First, install the build from npm:
npm install --save @shovonchoudhury/ckeditor5-build-standard
And use it in your website:
<div id="editor">
<p>This is the editor content.</p>
</div>
<script src="./node_modules/@shovonchoudhury/ckeditor5-build-standard/build/ckeditor.js"></script>
<script>
ClassicEditor
.create( document.querySelector( '#editor' ) )
.then( editor => {
window.editor = editor;
} )
.catch( error => {
console.error( 'There was a problem initializing the editor.', error );
} );
</script>
Or in your JavaScript application:
import ClassicEditor from '@shovonchoudhury/ckeditor5-build-standard';
// Or using the CommonJS version:
// const ClassicEditor = require( '@ckeditor/ckeditor5-build-classic' );
ClassicEditor
.create( document.querySelector( '#editor' ) )
.then( editor => {
window.editor = editor;
} )
.catch( error => {
console.error( 'There was a problem initializing the editor.', error );
} );
Built in Plugins
- Alignment,
- AutoImage,
- AutoLink,
- BlockQuote,
- Bold,
- Code,
- CodeBlock,
- Essentials,
- FindAndReplace,
- Font,
- GeneralHtmlSupport,
- Heading,
- Highlight,
- HorizontalLine,
- Image,
- ImageCaption,
- ImageInsert,
- ImageStyle,
- ImageToolbar,
- Indent,
- IndentBlock,
- Italic,
- Link,
- LinkImage,
- List,
- ListProperties,
- MediaEmbed,
- Paragraph,
- PasteFromOffice,
- RemoveFormat,
- SimpleUploadAdapter,
- SourceEditing,
- SpecialCharacters,
- SpecialCharactersEssentials,
- Strikethrough,
- Style,
- Table,
- TableCaption,
- TableCellProperties,
- TableProperties,
- TableToolbar,
- TextTransformation,
- TodoList,
- Underline,
- WordCount
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 or https://ckeditor.com/legal/ckeditor-oss-license.