Development environment for CKEditor 5 – the best browser-based rich text editor.

README.md

CKEditor 5 Tweet

npm version

Build Status BrowserStack Status Dependency Status devDependency Status

Join the chat at https://gitter.im/ckeditor/ckeditor5 Join newsletter Follow twitter

A set of ready-to-use rich text editors created with a powerful framework. Made with real-time collaborative editing in mind.

CKEditor 5 Classic rich text editor build screenshot

⚠ This package does not contain any source code

CKEditor 5 is distributed as four ready-to-use rich text editor builds which you can install from npm.

You can also customize the existing builds or build your own editors and features by using the CKEditor 5 Framework.

Table of contents

Quick start

CKEditor 5 Builds

CKEditor 5 Builds are a set of ready-to-use rich text editors. Every "build" provides a single type of editor with a set of features and a default configuration.

The following CKEditor 5 Builds are currently available:

Example

Creating an editor using a CKEditor 5 build is very simple and can be described in two steps:

  1. Load the desired editor via the <script> tag.
  2. Call the static create() method to create the editor.

In your HTML page add an element that CKEditor should replace:

<textarea name="content" id="editor"></textarea>

Load the classic editor build (you can choose between CDN, npm and zip downloads):

<script src="https://cdn.ckeditor.com/ckeditor5/<version>/classic/ckeditor.js"></script>

Call the ClassicEditor.create() method:

<script>
    ClassicEditor
        .create( document.querySelector( '#editor' ) )
        .catch( error => {
            console.error( error );
        } );
</script>

You’re ready to go!

To find out how to start with other builds check the Quick start guide in the CKEditor 5 documentation.

CKEditor 5 Framework

CKEditor 5 Builds allow you to quickly and easily initialize one of the many types of editors in your application. At the same time, CKEditor 5 is also a framework for creating custom-made rich text editing solutions.

To find out how to start building your own editor from scratch go to CKEditor 5 Framework overview section of CKEditor 5 documentation.

Documentation and FAQ

To find out more see the following CKEditor 5 documentation sections:

The documentation is far from being complete and will be constantly evolving (as will the editor) until it is ready for v1.0.0.

For FAQ please go to the CKEditor Ecosystem help center. For a high-level overview of the project see the CKEditor Ecosystem website.

Contributing and project organization

Ideas and discussions

The main development repository of CKEditor 5 is located at https://github.com/ckeditor/ckeditor5. This is the best place for bringing opinions and contributions. Letting the core team know if they are going in the right or wrong direction is great feedback and will be much appreciated!

Development

CKEditor 5 is a modular, multi-package, multi-repository project. It consists of several packages that create the editing framework, based on which the feature packages are implemented.

The ckeditor5 repository is the place that centralizes the development of CKEditor 5. It bundles different packages into a single place, adding the necessary helper tools for the development workflow, like the builder and the test runner. Basic information on how to set up the development environment can be found in the documentation.

Reporting issues and feature requests

Each repository handles its issues independently. However, it is recommended to report issues in this repository unless you know to which specific repository the issue belongs.

Read more on the Support page.

Releases

See CKEditor 5 release blog posts on the CKEditor blog.

Packages

Core libraries

Name Version Description
@ckeditor/ckeditor5-engine @ckeditor/ckeditor5-engine npm package badge The editing engine.
@ckeditor/ckeditor5-core @ckeditor/ckeditor5-core npm package badge The core editor architecture.
@ckeditor/ckeditor5-ui @ckeditor/ckeditor5-ui npm package badge The editor UI library.
@ckeditor/ckeditor5-utils @ckeditor/ckeditor5-utils npm package badge The editor utilities library.
@ckeditor/ckeditor5-upload @ckeditor/ckeditor5-upload npm package badge The file upload utilities.
@ckeditor/ckeditor5-widget @ckeditor/ckeditor5-widget npm package badge The widget API.
@ckeditor/ckeditor5-cloud-services @ckeditor/ckeditor5-cloud-services npm package badge CKEditor 5's Cloud Services integration layer.

Builds

Name Version Description
@ckeditor/ckeditor5-build-classic @ckeditor/ckeditor5-build-classic npm package badge The classic editor build.
@ckeditor/ckeditor5-build-inline @ckeditor/ckeditor5-build-inline npm package badge The inline editor build.
@ckeditor/ckeditor5-build-balloon @ckeditor/ckeditor5-build-balloon npm package badge The balloon editor (Medium-like) build.
@ckeditor/ckeditor5-build-decoupled-document @ckeditor/ckeditor5-build-decoupled-document npm package badge The document editor build, featuring the decoupled UI editor implementation.

Features

Name Version Description
@ckeditor/ckeditor5-adapter-ckfinder @ckeditor/ckeditor5-adapter-ckfinder npm package badge The CKFinder adapter for features which require upload capabilities.
@ckeditor/ckeditor5-alignment @ckeditor/ckeditor5-alignment npm package badge The text alignment feature.
@ckeditor/ckeditor5-autoformat @ckeditor/ckeditor5-autoformat npm package badge The autoformatting feature. Replaces predefined characters with a corresponding format (e.g. **foo** becomes bold <strong>foo</strong>).
@ckeditor/ckeditor5-autosave @ckeditor/ckeditor5-autosave npm package badge The autosave feature. Makes it easy to automatically save the data to the backend.
@ckeditor/ckeditor5-basic-styles @ckeditor/ckeditor5-basic-styles npm package badge The bold, italic, underline and code features.
@ckeditor/ckeditor5-block-quote @ckeditor/ckeditor5-block-quote npm package badge The block quote feature.
@ckeditor/ckeditor5-clipboard @ckeditor/ckeditor5-clipboard npm package badge The clipboard integration.
@ckeditor/ckeditor5-enter @ckeditor/ckeditor5-enter npm package badge The Enter key feature.
@ckeditor/ckeditor5-easy-image @ckeditor/ckeditor5-easy-image npm package badge Easy Image with CKEditor Cloud Services feature.
@ckeditor/ckeditor5-font @ckeditor/ckeditor5-font npm package badge The font size and font family features.
@ckeditor/ckeditor5-heading @ckeditor/ckeditor5-heading npm package badge The heading feature.
@ckeditor/ckeditor5-highlight @ckeditor/ckeditor5-highlight npm package badge The highlight feature (markers and pens).
@ckeditor/ckeditor5-image @ckeditor/ckeditor5-image npm package badge The image feature. Supports image styles and captioning.
@ckeditor/ckeditor5-link @ckeditor/ckeditor5-link npm package badge The link feature.
@ckeditor/ckeditor5-list @ckeditor/ckeditor5-list npm package badge The numbered and bulleted lists feature.
@ckeditor/ckeditor5-markdown-gfm @ckeditor/ckeditor5-markdown-gfm npm package badge The GitHub-flavored Markdown data processor.
@ckeditor/ckeditor5-media-embed @ckeditor/ckeditor5-media-embed npm package badge The media embed feature.
@ckeditor/ckeditor5-paragraph @ckeditor/ckeditor5-paragraph npm package badge The paragraph feature.
@ckeditor/ckeditor5-table @ckeditor/ckeditor5-table npm package badge The table feature. Work in progress.
@ckeditor/ckeditor5-typing @ckeditor/ckeditor5-typing npm package badge The typing and deleting features.
@ckeditor/ckeditor5-undo @ckeditor/ckeditor5-undo npm package badge The undo feature.

Editors

Name Version Description
@ckeditor/ckeditor5-editor-classic @ckeditor/ckeditor5-editor-classic npm package badge The classic editor implementation.
@ckeditor/ckeditor5-editor-inline @ckeditor/ckeditor5-editor-inline npm package badge The inline editor implementation.
@ckeditor/ckeditor5-editor-balloon @ckeditor/ckeditor5-editor-balloon npm package badge The balloon editor (Medium-like) implementation.
@ckeditor/ckeditor5-editor-decoupled @ckeditor/ckeditor5-editor-decoupled npm package badge The editor implementation with a decoupled UI.

Themes

Name Version Description
@ckeditor/ckeditor5-theme-lark @ckeditor/ckeditor5-theme-lark npm package badge The Lark theme.

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.