Marek Lewandowski f0e0605fef Merge branch 'monorepo-pending' 5 years ago
..
.github bdb754dc61 Internal: Updated the GitHub PR template because all packages share the same issue tracker now (see ckeditor/ckeditor5#5576). 6 years ago
docs 938bba1f13 Updated docs to monorepo state. 5 years ago
src b482fbf34a Docs: Fixed invalid code sample. Closes ckeditor/ckeditor5#6351. 5 years ago
tests 46defe5c19 Tests: Fixed to.be.equal() use. 5 years ago
theme 344ec71488 Internal: Bumped the year. [skip ci] 6 years ago
.editorconfig 7ff8cf8d0f Internal: Added config for package.json to .editorconfig. See #318. 6 years ago
.eslintrc.js 344ec71488 Internal: Bumped the year. [skip ci] 6 years ago
.gitattributes a604362215 Initialized .gitattributes 11 years ago
.gitignore 6b660532d2 Internal: Remove gulp dependency for pre-commit linting. 8 years ago
.stylelintrc e8c767c669 Used the external stylelint-config-ckeditor5 package for stylelint configuration. 6 years ago
.travis.yml f3662970ee Internal: Updated the version of Node.js on Travis. See ckeditor/ckeditor5#6542. 5 years ago
CHANGELOG.md 9ffc24b7db Docs: Corrected the changelog. [skip ci] 5 years ago
CONTRIBUTING.md b26bb5450b Docs: Made contributing guide link to our docs. [skip ci] 7 years ago
LICENSE.md 344ec71488 Internal: Bumped the year. [skip ci] 6 years ago
README.md 938bba1f13 Updated docs to monorepo state. 5 years ago
package.json 87f311a0de Release: v19.0.0. [skip ci] 5 years ago

README.md

CKEditor 5 editing engine

npm version Dependency Status devDependency Status

The CKEditor 5 editing engine implements a flexible MVC-based architecture for creating rich text editing features.

Architecture overview

  • Custom data model. CKEditor 5 implements a tree-structured custom data model, designed to fit multiple requirements such as enabling real-time collaboration and complex editing features (like tables or nested blocks).
  • Virtual DOM. CKEditor 5's editing engine features a custom, editing-oriented virtual DOM implementation that aims to hide browser quirks from your sight. No more contentEditable nightmares!
  • Real-time collaborative editing. The editor implements Operational Transformation for the tree-structured model as well as many other mechanisms which were required to create a seamless collaborative UX. Additionally, we provide cloud infrastructure and plugins enabling real-time collaborative editing in your application! Check the collaboration demo.
  • Extensible. The entire editor architecture was designed for maximum flexibility. The code is event-based and highly decoupled, allowing you to plug in or replace selected pieces. Features do not directly depend on each other and communicate in standardized ways.
  • Schema-less core. The core makes minimal assumptions and can be controlled through the schema. This leaves all decisions to plugins and to you.
  • Modular architecture. Not only can the core modules be reused and recomposed but even the features were implemented in a highly granular way. Feel like running a headless CKEditor 5 with a couple of features in Node.js? Not a problem!
  • Framework for building rich-text editors. Every use case is different and every editor needs to fulfill different goals. Therefore, we give you the freedom to create your own editors with custom-tailored features and UI.
  • Heavily tested from day one. CKEditor 5 comes with 3x more tests than React itself. All packages have 100% code coverage.
  • 8+ years of support. It is not yet another framework to be gone next year or a hyped proof-of-concept to fail in a real-life scenario. We have over 15 years of experience in creating rich text editors and invested over 4 years in designing and building your next future-proof rich text editor of choice.

Documentation

For a general introduction see the Overview of CKEditor 5 Framework guide and then the Editing engine architecture guide.

Additionally, refer to the @ckeditor/ckeditor5-engine package page in CKEditor 5 documentation for even more information.

License

Licensed under the terms of GNU General Public License Version 2 or later. For full details about the license, please check the LICENSE.md file or https://ckeditor.com/legal/ckeditor-oss-license.