This is the official developer documentation project for CKEditor. It uses the customized CKEditor JSDuck clone for compilation and is available online at http://docs.ckeditor.com.
Developer documentation is a part of CKEditor SDK.
Follow the steps listed below to build CKEditor documentation locally.
Clone this repository locally:
> git clone [email protected]: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 ckeditor-docs:
> cd ..
> git clone [email protected]:ckeditor/jsduck.git
Checkout the stable branch of the jsduck repository and install the latest ckeditor-jsduck-<version>.gem:
> cd jsduck
> git checkout stable
> gem install ckeditor-jsduck-<version>.gem
Go back to the ckeditor-docs repository and install npm dependencies:
> npm install
Then finally execute grunt docs-serve:
> grunt docs-serve [--options]
Available options:
--dev- use it to build documentation and view it locally,--skipApi- skips rendering API docs,--skipValidation- skips link validation,--clean- when--devflag is used,--cleanenables to clear thebuilddirectory before outputting new documentation
Use grunt docs to build documentation without setting a server.
The 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.
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:
-
Keeping
ckeditor-docs/andckeditor-dev/folders in the same directory. -
Setting the
CKEDITOR_DEV_PATHenvironment variable to point to yourckeditor-dev/folder path.
See the LICENSE.md file for licensing details.