CKEditor 5 – development repository

Project Status (November 2017)

1.0.0-alpha.2 was released on November 14, 2017. This is the 13th developer preview of the new CKEditor 5.

Read more about the status of the project in the CKEditor 5 v1.0.0-alpha.2 release blog post.

The first alpha versions will be followed by several releases before CKEditor 5 reaches v1.0.0. See the roadmap to 1.0.0 and beyond.

Demos

To play with the editors see the CKEditor 5 Builds website.

You can also find out more examples (such as Markdown output or text autoformatting) in the Features section of the documentation.

Follow us!

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

Documentation

For a high-level overview of the project see:

CKEditor 5 Builds website
CKEditor 5 Framework website.

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.

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 documentation.

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

Core libraries

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 utilities library.
`@ckeditor/ckeditor5-upload` Introduces the file upload utilities.
`@ckeditor/ckeditor5-widget` Introduces the widget API.

Editors

Package	Status
`@ckeditor/ckeditor5-editor-classic` The classic editor implementation.
`@ckeditor/ckeditor5-editor-inline` The inline editor implementation.
`@ckeditor/ckeditor5-editor-balloon` The balloon editor (Medium-like) implementation.

Features

Package	Status
`@ckeditor/ckeditor5-adapter-ckfinder` Introduces the CKFinder adapter for features which require upload capabilities.
`@ckeditor/ckeditor5-autoformat` Introduces the autoformatting feature. Replaces predefined characters with a corresponding format (e.g. `foo` becomes bolded `<strong>foo</strong>`).
`@ckeditor/ckeditor5-basic-styles` Introduces the bold, italic, underline and code features.
`@ckeditor/ckeditor5-block-quote` Introduces the block quote feature.
`@ckeditor/ckeditor5-clipboard` Introduces the clipboard integration.
`@ckeditor/ckeditor5-enter` Introduces the Enter key feature.
`@ckeditor/ckeditor5-easy-image` Introduces Easy Image with Cloud Services 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.

Builds

Package	Status
`@ckeditor/ckeditor5-build-classic` The classic editor build.
`@ckeditor/ckeditor5-build-inline` The inline editor build.
`@ckeditor/ckeditor5-build-balloon` The balloon editor (Medium-like) build.

License

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

c2chance/ckeditor5