暂无描述

Maksymilian Barnaś c80da76c95 Merge pull request #273 from ckeditor/t/218 9 年之前
dev c80da76c95 Merge pull request #273 from ckeditor/t/218 9 年之前
src 9a52394f84 Changed name and order of arguments when using Batch methods. 9 年之前
tests a34e652992 Merge branch 'master' into ckeditor5-engine/t/455 9 年之前
.editorconfig dd7edf242e Initialized .editorconfig. 11 年之前
.gitattributes bab0e300aa Initialized .gitattributes 11 年之前
.gitignore f6bf3983ca Removed unnecessary definition from gitignore. 9 年之前
.jscsrc f4d101e540 Updated `.jscsrc`. 9 年之前
.jshintrc cfbe868736 Removed use strict in all ES6 modules and fixed related files. See https://github.com/ckeditor/ckeditor5/issues/149. 9 年之前
CHANGES.md 39adab72d3 Fixed formatting in existing MD files and created templates for new plugins accordingly. 9 年之前
CONTRIBUTING.md 39adab72d3 Fixed formatting in existing MD files and created templates for new plugins accordingly. 9 年之前
LICENSE.md 39adab72d3 Fixed formatting in existing MD files and created templates for new plugins accordingly. 9 年之前
README.md 41142e9fe1 Release date corrected in README. 9 年之前
bender.js 83e3594600 Added license header to two files. 9 年之前
gulpfile.js b82f506426 Moved docs bulder to ckeditor5-dev-builder repository. 9 年之前
package.json b82f506426 Moved docs bulder to ckeditor5-dev-builder repository. 9 年之前

README.md

CKEditor 5 – Development Repository

Dependency Status devDependency Status

Project Status (July 2016)

Version 0.1.0 was released on July 14, 2016. This is the first developer preview of the new CKEditor 5, and the first 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.1.0 release blog post.

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

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

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.