CKEditor 5 – development repository

Project Status (December 2016)

Version 0.5.0 was released on November 29, 2016. This is the 5th developer preview of the new CKEditor 5.

Read more in the CKEditor 5 v0.5.0 release blog post and check the CKEditor 5 sample.

It is not production ready and will be followed by several releases before it reaches its first stable 1.0.0 version.

Follow us!

• Periodic news and updates about the project.
• Roadmap to 1.0.0 and beyond.

Project Organization

Design and discussions

https://github.com/ckeditor/ckeditor5 is the CKEditor 5 main development repository. 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!

(Note: At the early stage, most of the high-level discussions were lead in ckeditor5-design repository.)

Development

CKEditor 5 is a modular, multi-package, multi-repository project. It consists of a several packages which 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 wiki pages.

Reporting issues and feature requests

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

Packages

Editing framework

Package	Status
@ckeditor/ckeditor5-engine The editing engine.
@ckeditor/ckeditor5-core The core editor architecture.
@ckeditor/ckeditor5-ui The editor UI library.
@ckeditor/ckeditor5-utils The editor utils library.

Editors

Package	Status
@ckeditor/ckeditor5-editor-classic The classic editor implementation.
@ckeditor/ckeditor5-editor-inline The inline editor implementation.

Features

Package	Status
@ckeditor/ckeditor5-autoformat Introduces the autoformatting feature. Replaces predefined characters with corresponding format (e.g. **foo** becomes bolded <strong>foo</strong>).
@ckeditor/ckeditor5-basic-styles Introduces the bold and italic features.
@ckeditor/ckeditor5-clipboard Introduces the clipboard integration.
@ckeditor/ckeditor5-enter Introduces the enter key feature.
@ckeditor/ckeditor5-heading Introduces the heading feature.
@ckeditor/ckeditor5-image Introduces the image feature. Supports image styles and captioning.
@ckeditor/ckeditor5-link Introduces the link feature.
@ckeditor/ckeditor5-list Introduces numbered and bulleted lists feature.
@ckeditor/ckeditor5-markdown-gfm Introduces GitHub flavored Markdown data processor.
@ckeditor/ckeditor5-paragraph Introduces the paragraph feature.
@ckeditor/ckeditor5-typing Introduces typing and deleting features.
@ckeditor/ckeditor5-undo Introduces the undo feature.

Themes

Package	Status
@ckeditor/ckeditor5-theme-lark The lark theme.

License

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