CKEditor 4 Official Documentation
Developer documentation is a part of CKEditor SDK.
Building the Documentation
Follow the steps listed below to build CKEditor documentation locally.
Clone this repository locally:
> git clone firstname.lastname@example.org:ckeditor/ckeditor-docs.git
Go to the
ckeditor-docs directory and update the submodules:
> cd ckeditor-docs > git submodule update --init
Clone the custom CKEditor JSDuck repository to a separate folder next to
> cd .. > git clone email@example.com:ckeditor/jsduck.git
stable branch of the
jsduck repository and install the latest
> cd jsduck > git checkout stable > gem install ckeditor-jsduck-<version>.gem
Go back to the
ckeditor-docs repository and execute
> sh build.sh
All "Developer's Guide" articles as well as the Plugin, Widget and Skin SDKs are defined in the
guides/ folder, including the
guides.json file which defines the Table of Contents tree and the meta information.
repos/ folder contains submodules for the repositories currently included in the API documentation. As expected, the API is documented inline in the source code contained in these repositories, and is then integrated into the documentation files.
Using Local Versions of ckeditor-dev
While the main CKEditor repository for API documents, ckeditor-dev, is available as a submodule, it is also possible to make the builder use its local copy to avoid submodule limitations and speed up API documentation work. There are two ways to achieve it:
ckeditor-dev/folders in the same directory.
CKEDITOR_DEV_PATHenvironment variable to point to your
LICENSE.md file for licensing details.