No Description

Piotrek Koszuliński 1ea8f697a4 Merge pull request #379 from ckeditor/t/374 9 years ago
build 181e663e8e Updated build README.md with proper links. 9 years ago
dev 12ee83e5ba Aligned gulpfile to the bundler-rollup changes. 9 years ago
.editorconfig dd7edf242e Initialized .editorconfig. 11 years ago
.gitattributes bab0e300aa Initialized .gitattributes 11 years ago
.gitignore 74c7ffebf4 Updated test package usage to its changes. 9 years ago
.jscsrc f4d101e540 Updated `.jscsrc`. 9 years ago
.jshintrc 6f9612d62f Changed: JSHint browser setting turned to false. 9 years ago
.travis.yml d6c67cccf9 Use the new reporter option of ckeditor5-dev-tests. 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 bd189b21f8 Updated readme. 9 years ago
build-config.js 3a44985e87 Improved bundle config. 9 years ago
gulpfile.js 3945ccc2c1 Merge branch 'master' of https://github.com/ckeditor/ckeditor5 into t/374 9 years ago
package.json 350845f383 Bumped up the bundler rollup. 9 years ago

README.md

CKEditor 5 – Development Repository

Build Status Dependency Status devDependency Status

Project Status (December 2016)

Version 0.5.0 was released on November 29, 2016. This is the 5th developer preview of the new CKEditor 5.

It is not production ready and will be followed by several releases before it reaches its first stable 1.0.0 version.

Read more in the CKEditor 5 v0.5.0 release blog post.

Check the basic CKEditor 5 sample on the GitHub.io page.

Periodic news and updates about the project can be found in the CKEditor 5 design repository.

Project Organization

Design

Discussions, decisions and documentation about the architecture design of CKEditor 5 can be found in 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 and will be much appreciated!

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 set up the development environment can be found in the wiki pages.

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

Other key repositories are:

  • ckeditor5-engine – Stores the editor's editing engine (data model, editing and data views, etc.). A big part of the entire project development happens in this repository, as the engine is the base of the editor.
  • ckeditor5-ui and ckeditor5-ui-default – Stores the UI framework and the 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 do not know where to report an issue, report it here.
  • ckeditor5-engine – Issues related to the engine API.
  • Other ckeditor5-* repositories – 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.