No Description

Maksymilian Barnaś 3e706d2af7 Moved tests to proper location reflecting project directory structure. 9 years ago
dev 3e706d2af7 Moved tests to proper location reflecting project directory structure. 9 years ago
src d40cac4ea4 Removed path.js as it's not used anywhere. 9 years ago
tests cd974279c8 Used new View API in ClassicTestEditor. 9 years ago
.editorconfig dd7edf242e Initialized .editorconfig. 11 years ago
.gitattributes bab0e300aa Initialized .gitattributes 11 years ago
.gitignore b068697cfd Minor improvements for the gulp docs task. 9 years ago
.jscsrc f6880f02d5 Merge branch 'master' into esnext 10 years ago
.jshintrc 0122aa7618 Removed latedef config from .jshintrc files. Fixes #143. 9 years ago
CHANGES.md 39adab72d3 Fixed formatting in existing MD files and created templates for new plugins accordingly. 9 years ago
CONTRIBUTING.md 39adab72d3 Fixed formatting in existing MD files and created templates for new plugins accordingly. 9 years ago
LICENSE.md 39adab72d3 Fixed formatting in existing MD files and created templates for new plugins accordingly. 9 years ago
README.md 282a3ab661 Corrected misspelling. 9 years ago
bender.js d67e69f9d9 Hot fixes issue with Istanbul – Bender should restart a test sooner. 9 years ago
gulpfile.js a7da23a907 Added early version of task running 9 years ago
package.json 2c41ad2b09 Merge branch 'master' into t/190 9 years ago

README.md

CKEditor 5 – Development Repository

Dependency Status devDependency Status

Project Status (January 2016)

WARNING: The project is still at its first development stage. No usable software is currently available.

Periodic updates and news about the project can be found at the wiki pages of ckeditor5.

Project Organization

Design

Discussions, decisions and documentation about the architecture design of CKEditor 5 are made at the "ckeditor5-design" repository:

At the current stage, 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.

Development

The project is split into several different repositories, as described in the design wiki. Most of these repositories are generally available within the CKEditor organization in GitHub, prefixed with "ckeditor5".

The ckeditor5 repository is the place that centralizes the development of CKEditor 5. It bundles different repositories 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 setup the development environment can be found in the wiki pages.

The ckeditor5 repository contains also the core classes which implement the base architecture of the CKEditor 5 framework.

Another key repositories are:

  • ckeditor5-engine, which keeps the editor's editing engine (data model, editing and data views, etc.). Big part of the development happens in this repository, as the engine is the base of the editor.
  • ckeditor5-ui and ckeditor5-ui-default, which keep the UI framework and default UI library (based on this framework). The official features use these packages to create their UI.

Diagram of CKEditor 5 key repositories

Reporting Issues and Feature Requests

Each repository independently handles its issues, so focus is kept on their scope:

  • ckeditor5-design: issues related to macro program design, not going into the specifics of other repos.
  • ckeditor5: issues related to the core API as well as the development environment and workflow. When you don't know where to report an issue, report it here.
  • ckeditor5-engine: issues related to the engine API.
  • other ckeditor5-* repos: issues related to all other parts of the code, like features, UI libraries, themes, etc.

License

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