Skip to content

Latest commit

 

History

History
496 lines (424 loc) · 25.1 KB

README.md

File metadata and controls

496 lines (424 loc) · 25.1 KB

CKEditor 5 – development repository

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

Project Status (October 2017)

1.0.0-alpha.1 was released on October 3, 2017. This is the 12th developer preview of the new CKEditor 5.

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

The first alpha version will be followed by several releases before it 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!

Documentation

For a high-level overview of the project see:

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.

Read more in the Support page.

Packages

Core libraries

Package Status
@ckeditor/ckeditor5-engine
The editing engine.
ckeditor5-engine npm package badge build status badge ckeditor5-engine coverage badge
@ckeditor/ckeditor5-core
The core editor architecture.
ckeditor5-core npm package badge build status badge ckeditor5-core coverage badge
@ckeditor/ckeditor5-ui
The editor UI library.
ckeditor5-ui npm package badge build status badge ckeditor5-ui coverage badge
@ckeditor/ckeditor5-utils
The editor utilities library.
ckeditor5-utils npm package badge build status badge ckeditor5-utils coverage badge
@ckeditor/ckeditor5-upload
Introduces the file upload utilities.
ckeditor5-upload npm package badge build status badge ckeditor5-upload coverage badge
@ckeditor/ckeditor5-widget
Introduces the widget API.
ckeditor5-widget npm package badge build status badge ckeditor5-widget coverage badge

Editors

Package Status
@ckeditor/ckeditor5-editor-classic
The classic editor implementation.
ckeditor5-editor-classic npm package badge build status badge ckeditor5-editor-classic coverage badge
@ckeditor/ckeditor5-editor-inline
The inline editor implementation.
ckeditor5-editor-inline npm package badge build status badge ckeditor5-editor-inline coverage badge
@ckeditor/ckeditor5-editor-balloon
The balloon editor (Medium-like) implementation.
ckeditor5-editor-balloon npm package badge build status badge ckeditor5-editor-balloon coverage badge

Features

Package Status
@ckeditor/ckeditor5-adapter-ckfinder
Introduces the CKFinder adapter for features which require upload capabilities.
ckeditor5-adapter-ckfinder npm package badge build status badge ckeditor5-adapter-ckfinder coverage badge
@ckeditor/ckeditor5-autoformat
Introduces the autoformatting feature. Replaces predefined characters with a corresponding format (e.g. **foo** becomes bolded <strong>foo</strong>).
ckeditor5-autoformat npm package badge build status badge ckeditor5-autoformat coverage badge
@ckeditor/ckeditor5-basic-styles
Introduces the bold, italic, underline and code features.
ckeditor5-basic-styles npm package badge build status badge ckeditor5-basic-styles coverage badge
@ckeditor/ckeditor5-block-quote
Introduces the block quote feature.
ckeditor5-block-quote npm package badge build status badge ckeditor5-block-quote coverage badge
@ckeditor/ckeditor5-clipboard
Introduces the clipboard integration.
ckeditor5-clipboard npm package badge build status badge ckeditor5-clipboard coverage badge
@ckeditor/ckeditor5-enter
Introduces the Enter key feature.
ckeditor5-enter npm package badge build status badge ckeditor5-enter coverage badge
@ckeditor/ckeditor5-easy-image
Introduces Easy Image with Cloud Services feature.
ckeditor5-easy-image npm package badge build status badge ckeditor5-easy-image coverage badge
@ckeditor/ckeditor5-heading
Introduces the heading feature.
ckeditor5-heading npm package badge build status badge ckeditor5-heading coverage badge
@ckeditor/ckeditor5-image
Introduces the image feature. Supports image styles and captioning.
ckeditor5-image npm package badge build status badge ckeditor5-image coverage badge
@ckeditor/ckeditor5-link
Introduces the link feature.
ckeditor5-link npm package badge build status badge ckeditor5-link coverage badge
@ckeditor/ckeditor5-list
Introduces numbered and bulleted lists feature.
ckeditor5-list npm package badge build status badge ckeditor5-list coverage badge
@ckeditor/ckeditor5-markdown-gfm
Introduces GitHub-flavored Markdown data processor.
ckeditor5-markdown-gfm npm package badge build status badge ckeditor5-markdown-gfm coverage badge
@ckeditor/ckeditor5-paragraph
Introduces the paragraph feature.
ckeditor5-paragraph npm package badge build status badge ckeditor5-paragraph coverage badge
@ckeditor/ckeditor5-typing
Introduces typing and deleting features.
ckeditor5-typing npm package badge build status badge ckeditor5-typing coverage badge
@ckeditor/ckeditor5-undo
Introduces the undo feature.
ckeditor5-undo npm package badge build status badge ckeditor5-undo coverage badge

Themes

Package Status
@ckeditor/ckeditor5-theme-lark
The Lark theme.
ckeditor5-theme-lark npm package badge build status badge

Builds

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

License

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