ckeditor5 README

The project's README from github.com/ckeditor/ckeditor5. As one markdown file: README.md.

CKEditor 5 Tweet

npm version codecov CircleCI TypeScript Support

Join newsletter Follow Twitter

CKEditor 5 is a modern JavaScript rich-text editor with MVC architecture, custom data model, and virtual DOM, written from scratch in TypeScript with excellent support for modern bundlers. It provides every type of WYSIWYG editing solution imaginable with extensive collaboration support. From editors similar to Google Docs and Medium to Slack or Twitter-like applications, all is possible within a single editing framework. As a market leader, it is constantly expanded and updated.

A composition of screenshots presenting various features of CKEditor 5 rich text editor

Table of contents

Quick start

Refer to the Quick Start guide to learn more about CKEditor 5 installation.

CKEditor 5 Builder

The easiest way to start using CKEditor 5 with all the features you need is to prepare a customized setup with the CKEditor 5 Builder. All you need to do is choose the preferred editor type as a base, add all the required plugins, and download the ready-to-use package.

Build with AI

You can also set up CKEditor 5 with an AI coding agent such as Claude Code, Cursor, Codex, or Copilot. Install the official CKEditor skill, and your agent will handle the installation, configuration, and licensing for you. See the Build with AI guide.

TypeScript support

CKEditor 5 is a TypeScript project. Starting from v37.0.0, official packages provide native type definitions.

CKEditor 5 advanced installation

For more advanced users or those who need to integrate CKEditor 5 with their applications, we prepared integrations with popular JavaScript frameworks:

CKEditor 5 Framework

CKEditor 5 is also a framework for creating custom-made rich text editing solutions.

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

Documentation and FAQ

Extensive documentation dedicated to all things CKEditor 5-related is available. You will find basic guides that will help you kick off your project, advanced deep-dive tutorials to tailor the editor to your specific needs, and help sections with solutions and answers to any of your possible questions. To find out more refer to the following CKEditor 5 documentation sections:

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

Releases

Follow the CKEditor 5 changelog for release details and check out the CKEditor 5 release blog posts on the CKSource blog for important release highlights and additional information.

Editing and collaboration features

The CKEditor 5 Framework offers access to a plethora of various plugins, supporting all kinds of editing features.

From collaborative editing support providing comments and tracking changes, through editing tools that let users control the content looks and structure such as tables, lists, and font styles, to accessibility helpers and multi-language support - CKEditor 5 is easily extensible and customizable. Special duty features like Markdown input and output and source editing, or export to PDF and Word provide solutions for users with diverse and specialized needs. Images and videos are easily supported and CKEditor 5 offers various upload and storage systems to manage these.

The number of options and the ease of customization and adding new ones make the editing experience even better for any environment and professional background.

Refer to the CKEditor 5 Features documentation for details.

Create a free account and test full potential

If you want to check full CKEditor 5 capabilities, including premium features, sign up for a free non-commitment 14-day trial.

Contributing and project organization

Ideas and discussions

The 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, monorepo 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.

See the official contributors' guide to learn how to contribute your code to the project.

Reporting issues and feature requests

Report issues in the ckeditor5 repository. Read more in the Getting support section of the CKEditor 5 documentation.

License

Licensed under a dual-license model, this software is available under:

For more information, see: https://ckeditor.com/legal/ckeditor-licensing-options.

ckeditor5 (ckeditor/ckeditor5)

Searching Database…

10.5K ·GitHub
Ckeditor5
What is this?CKEditor 5 is a modern JavaScript rich-text (WYSIWYG) editor with an MVC architecture, a custom data model and a virtual DOM, written from scratch in TypeScript.
Is it a ready-made editor, or a framework for building my own?Both: you install ready-made editor packages into your web app, and CKEditor 5 is also a framework for creating custom-made rich text editing solutions.
How do I add it to my project?Install the npm package (npm install ckeditor5) and build with a bundler like Vite, or use the online CKEditor 5 Builder to pick an editor type and plugins and download a ready-to-use package. Official Angular, React and Vue integrations are also available.
Do I need anything special in my stack, like TypeScript or a bundler?It fits a normal modern JavaScript stack: npm installs require a bundler (Vite is recommended), and official packages ship native TypeScript type definitions since v37.0.0.
Can I use it for free in a commercial product, or is there a catch?There is a catch: it is dual-licensed under GNU GPL v2 or later or commercial terms from CKSource. Free use means complying with the GPL; otherwise you need a paid commercial license.
What can the editor do out of the box?Collaborative editing with comments and track changes, tables, lists and font styles, accessibility helpers, multi-language support, Markdown input and output, source editing, and export to PDF and Word. Images and videos are supported with various upload and storage systems.
Can an AI coding agent set it up for me?Yes. Install the official CKEditor skill and agents such as Claude Code, Cursor, Codex or Copilot will handle the installation, configuration and licensing for you.
Can I try the premium features before paying?Yes — sign up for a free non-commitment 14-day trial to test the full CKEditor 5 capabilities, including premium features.
What kinds of editors can I build with it?Anything from Google Docs- or Medium-like editors to Slack- or Twitter-like applications — the README says all are possible within this single editing framework.
What are similar projects?tinymce, tiptap, slate, quill, BlockNote, pell, lexical, draft-js
Which topics is it in?contenteditable, wysiwyg-editor, rich-text-editor, wysiwyg, text-editor, gpl, plugins, angular, gplv2, collaboration, monorepo, editor
Creator
ckeditor
Size
672.2 MB
Stars
10.5K
Updated
CommitOct 16Releasev49.0.0Oct 08
Age
11y
Commits · 90 Days