Nenhuma descrição

Anna Tomanek 9b415c31e6 Project status updated in README. 9 anos atrás
build 181e663e8e Updated build README.md with proper links. 9 anos atrás
dev 5fdb3b6618 Added new features to the build config. 9 anos atrás
.editorconfig dd7edf242e Initialized .editorconfig. 11 anos atrás
.gitattributes bab0e300aa Initialized .gitattributes 11 anos atrás
.gitignore e49f660a1d Added readme file to build directory. Updated .gitignore file. 9 anos atrás
.jscsrc f4d101e540 Updated `.jscsrc`. 9 anos atrás
.jshintrc 6f9612d62f Changed: JSHint browser setting turned to false. 9 anos atrás
CHANGES.md 39adab72d3 Fixed formatting in existing MD files and created templates for new plugins accordingly. 9 anos atrás
CONTRIBUTING.md 39adab72d3 Fixed formatting in existing MD files and created templates for new plugins accordingly. 9 anos atrás
LICENSE.md 39adab72d3 Fixed formatting in existing MD files and created templates for new plugins accordingly. 9 anos atrás
README.md 9b415c31e6 Project status updated in README. 9 anos atrás
bender.js 5e5b49a428 Using new builder configuration. 9 anos atrás
gulpfile.js 199d17dfed Use clearly relative paths, as compiler recommends. 9 anos atrás
package.json 044628358a Merge pull request #344 from ckeditor/t/343 9 anos atrás

README.md

CKEditor 5 – Development Repository

Dependency Status devDependency Status

Project Status (October 2016)

Version 0.3.0 was released on October 4, 2016. This is the third developer preview of the new CKEditor 5, and the third demo-able version.

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.3.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.