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
这是什么东西?CKEditor 5 是一个现代的 JavaScript 富文本(所见即所得)编辑器,采用 MVC 架构,有自定义数据模型和虚拟 DOM,用 TypeScript 从零编写。
它是一个现成的编辑器,还是用来自己搭建的框架?两者都是:你可以把现成的编辑器包安装到自己的网页应用里,同时 CKEditor 5 也是一个框架,可以用来打造定制的富文本编辑方案。
怎么把它加到我的项目里?安装 npm 包(npm install ckeditor5),然后用 Vite 这类打包工具构建;或者使用在线的 CKEditor 5 Builder 选择编辑器类型和插件,下载现成的安装包。官方也提供 Angular、React 和 Vue 的集成。
我的技术栈需要有特别的东西吗,比如 TypeScript 或打包工具?它适配常规的现代 JavaScript 技术栈:npm 安装需要打包工具(推荐 Vite),官方包从 v37.0.0 起就自带原生 TypeScript 类型定义。
在商业产品里能免费使用吗,还是有什么限制?确实有限制:它采用双重许可,即 GNU GPL v2 或更高版本,或者 CKSource 的商业条款。免费使用就意味着要遵守 GPL;否则需要购买商业许可证。
这个编辑器开箱即用都能做什么?支持带评论和修订记录的协同编辑、表格、列表和字体样式、无障碍辅助功能、多语言支持、Markdown 输入输出、源码编辑,以及导出为 PDF 和 Word。图片和视频也能配合各种上传和存储方案使用。
AI 编程助手能帮我把它装好吗?可以。安装官方的 CKEditor 技能后,Claude Code、Cursor、Codex、Copilot 这类助手就会替你完成安装、配置和授权。
付费之前能先试用高级功能吗?可以——注册即可免费试用 14 天,无需承诺,可以体验 CKEditor 5 的全部功能,包括高级功能。
用它都能做出哪些类型的编辑器?从类似 Google Docs 或 Medium 的编辑器,到类似 Slack 或 Twitter 的应用都行——README 里说,在这个统一的编辑框架内这些全都能实现。
What are similar projects?tinymce, tiptap, slate, quill, BlockNote, pell, lexical, draft-js
Creator
ckeditor
Size
672.2 MB
Stars
10.5K
Age
11y
Commits · 90 Days