CKEditor 5 [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Check%20out%20CKEditor%205%20on%20GitHub%20&url=https://github.com/ckeditor/ckeditor5) =================================== A set of ready to use rich text editors created with a powerful framework. Made with real-time collaborative editing in mind. [![Join the chat at https://gitter.im/ckeditor/ckeditor5](https://badges.gitter.im/ckeditor/ckeditor5.svg)](https://gitter.im/ckeditor/ckeditor5?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.org/ckeditor/ckeditor5.svg?branch=master)](https://travis-ci.org/ckeditor/ckeditor5) [![Dependency Status](https://img.shields.io/david/ckeditor/ckeditor5.svg)](https://david-dm.org/ckeditor/ckeditor5) [![devDependency Status](https://img.shields.io/david/dev/ckeditor/ckeditor5.svg)](https://david-dm.org/ckeditor/ckeditor5?type=dev) ## Table of contents - [Quick start](#quick-start) - [CKEditor 5 Builds](#ckeditor-5-builds) - [Classic editor](#classic-editor) - [CKEditor 5 Framework](#ckeditor-5-framework) - [Documentation and FAQ](#documentation-and-faq) - [Contributing and project organization](#contributing-and-project-organization) - [Ideas and discussions](#ideas-and-discussions) - [Development](#development) - [Reporting issues and feature requests](#reporting-issues-and-feature-requests) - [Releases](#releases) - [Packages](#packages) - [Core libraries](#core-libraries) - [Editors](#editors) - [Features](#features) - [Themes](#themes) - [Builds](#builds) - [License](#license) ## 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: - [Classic editor](https://docs.ckeditor.com/ckeditor5/latest/builds/guides/overview.html#Classic-editor) - [Inline editor](https://docs.ckeditor.com/ckeditor5/latest/builds/guides/overview.html#Inline-editor) - [Balloon editor](https://docs.ckeditor.com/ckeditor5/latest/builds/guides/overview.html#Balloon-editor) #### Classic editor 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 ` Call the [ClassicEditor.create()](https://docs.ckeditor.com/ckeditor5/latest/api/module_editor-classic_classiceditor-ClassicEditor.html#create) method: ``` ``` You’re ready to go! To find out how to start with other builds please go to the [quick start section of CKEditor 5 documentation](https://docs.ckeditor.com/ckeditor5/latest/builds/guides/quick-start.html). ### 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](https://docs.ckeditor.com/ckeditor5/latest/framework/guides/overview.html). ## Documentation and FAQ To find out more see the following [CKEditor 5 documentation](https://docs.ckeditor.com/ckeditor5/latest/index.html) sections: * [API documentation](https://docs.ckeditor.com/ckeditor5/latest/api/index.html) * [CKEditor 5 Framework documentation](https://docs.ckeditor.com/ckeditor5/latest/framework/index.html) * [CKEditor 5 Builds documentation](https://docs.ckeditor.com/ckeditor5/latest/builds/index.html) * [CKEditor 5 Features documentation](https://docs.ckeditor.com/ckeditor5/latest/features/index.html) * [CKEditor 5 Examples](https://docs.ckeditor.com/ckeditor5/latest/examples/index.html) 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](https://support.ckeditor.com/hc/en-us). For a high-level overview of the project see the [CKEditor Ecosystem website](https://ckeditor.com). ## Contributing and project organization ### Ideas and discussions The main development repository of CKEditor 5 is located at [https://github.com/ckeditor/ckeditor5](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 a several packages which create the editing framework, based on which the feature packages are implemented. The [ckeditor5](https://github.com/ckeditor/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](https://docs.ckeditor.com/ckeditor5/latest/framework/guides/contributing/development-environment.html) 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](https://github.com/ckeditor/ckeditor5/issues) unless you know to which specific repository the issue belongs. Read more in the [Support](https://docs.ckeditor.com/ckeditor5/latest/framework/guides/support/getting-support.html) page. ## Releases The latest five releases: * [Second alpha release of CKEditor 5 v1.0.0](https://ckeditor.com/blog/Second-alpha-release-of-CKEditor-5-v1.0.0/) * [First alpha release of CKEditor 5 v1.0.0](https://ckeditor.com/blog/First-alpha-release-of-CKEditor-5-v1.0.0/) * [11th developer preview of CKEditor 5](https://ckeditor.com/blog/11th-developer-preview-of-CKEditor-5-available/) * [10th developer preview of CKEditor 5 available](https://ckeditor.com/blog/10th-developer-preview-of-CKEditor-5-available/) * [9th developer preview of CKEditor 5 available](https://ckeditor.com/blog/9th-developer-preview-of-CKEditor-5-available/) For more CKEditor 5 release blog posts [browse the CKEditor blog](https://ckeditor.com/blog/?category=releases&tags=CKEditor-5). ## 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.