The development repository of CKEditor 4.
Switch branches/tags
Clone or download
Comandeer Merge pull request #2428 from ckeditor/t/2406
Added package.json keywords
Latest commit a7c6413 Sep 20, 2018
Permalink
Failed to load latest commit information.
.github Update docs links to be final paths. Aug 13, 2018
.npm Badge URL corrected. Aug 27, 2018
adapters Update guide links to 'glink' format. Aug 22, 2018
assets Duplicated readme assets in root directory to get around #2405. Sep 12, 2018
core Merge branch 'next' Sep 12, 2018
dev Removed unused lang files. Sep 13, 2018
lang Updated language files. Sep 11, 2018
plugins Removed edge fix as it seems to be not needed anymore Sep 17, 2018
samples Fixed typo in plugin name Aug 18, 2018
skins Update docs links to be final paths. Aug 13, 2018
tests Skipping edge in 'hacks' if Sep 17, 2018
.editorconfig Initialized .editorconfig. Aug 18, 2014
.gitattributes Initialized .gitattributes Aug 14, 2014
.gitignore Started a dedicated README.md for the npm. Aug 27, 2018
.jscsrc JSCS now requires line feed at file end Jan 19, 2018
.jshintrc Update dependencies. Jan 20, 2017
.mailmap Reordered mailmap alphabetically. Apr 17, 2014
.travis.yml Added Travis build scripts. May 29, 2017
CHANGES.md Update changelog entry. Sep 14, 2018
LICENSE.md Updated license header. Jan 21, 2018
README.md Update docs links to be final paths. Aug 13, 2018
bender.ci.js Bumped MatJax references version. Jun 25, 2018
bender.js Prepared benderjs. Apr 16, 2018
ckeditor.js Updated license URLs. Jan 31, 2018
config.js Updated license URLs. Jan 31, 2018
contents.css Changelog and API docs corrections for v4.10, part 3. Jun 26, 2018
gruntfile.js Remove enterkey plugin from linter. Jun 8, 2017
package.json Added package.json keywords. Sep 19, 2018
styles.js Update docs links to be final paths. Aug 13, 2018

README.md

CKEditor 4 - The best browser-based WYSIWYG editor

devDependencies Status

This repository contains the development version of CKEditor 4.

Attention: The code in this repository should be used locally and for development purposes only. We do not recommend using it in production environment because the user experience will be very limited. For that purpose, you should either build the editor (see below) or use an official release available on the CKEditor website.

Code Installation

There is no special installation procedure to install the development code. Simply clone it to any local directory and you are set.

Available Branches

This repository contains the following branches:

  • master – Development of the upcoming minor release.
  • major – Development of the upcoming major release.
  • stable – Latest stable release tag point (non-beta).
  • latest – Latest release tag point (including betas).
  • release/A.B.x (e.g. 4.0.x, 4.1.x) – Release freeze, tests and tagging. Hotfixing.

Note that both master and major are under heavy development. Their code did not pass the release testing phase, though, so it may be unstable.

Additionally, all releases have their respective tags in the following form: 4.4.0, 4.4.1, etc.

Samples

The samples/ folder contains some examples that can be used to test your installation. Visit CKEditor 4 SDK for plenty of samples showcasing numerous editor features, with source code readily available to view, copy and use in your own solution.

Code Structure

The development code contains the following main elements:

  • Main coding folders:
    • core/ – The core API of CKEditor 4. Alone, it does nothing, but it provides the entire JavaScript API that makes the magic happen.
    • plugins/ – Contains most of the plugins maintained by the CKEditor 4 core team.
    • skin/ – Contains the official default skin of CKEditor 4.
    • dev/ – Contains some developer tools.
    • tests/ – Contains the CKEditor 4 tests suite.

Building a Release

A release-optimized version of the development code can be easily created locally. The dev/builder/build.sh script can be used for that purpose:

> ./dev/builder/build.sh

A "release ready" working copy of your development code will be built in the new dev/builder/release/ folder. An Internet connection is necessary to run the builder, for its first time at least.

Testing Environment

Read more on how to set up the environment and execute tests in the CKEditor 4 Testing Environment guide.

Reporting Issues

Please use the CKEditor 4 GitHub issue page to report bugs and feature requests.

License

Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.

For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license