We moved all examples to the ckeditor-docs
repository. You will find all the former SDK samples in the Examples section of the CKEditor 4 documentation.
This repository contained the CKEditor SDK that included the CKEditor developer documentation as well as working CKEditor samples showcasing its numerous features.
It was used for building the online version of the CKEditor SDK which was previously available at https://sdk.ckeditor.com/. You could also download the built package (click the Download SDK button at https://sdk.ckeditor.com/) to use it offline.
Note: Use the Issues tab to report any bugs and tips. Thanks!
Get Node.js.
Get Ruby.
Follow instructions in ckeditor-docs in order to setup working documentation dev environment.
Install Compass:
gem update --system
gem install compass
First things first, install all package dependencies:
npm install
Setup the the builder, submodules, etc.:
grunt setup
(Optional) Update Git submodules (will commit submodule HEADs change):
grunt update
Run Grunt build
task to build the CKEditor SDK:
grunt build
grunt setup
Initializes the SDK builder.
grunt update [OPTIONS]
Updates CKEditor presets and CKEditor docs submodules to the --sdk-ckeditor-version
(defaults to master
), commits this change and updates all submodules recursively.
--sdk-ckeditor-version=VERSION
Specifies which branch or tag to checkout the submodules. Defaults to master
.
grunt build [OPTIONS] [FLAGS]
When the build process is finished, you can find a working copy of CKEditor SDK in the build/<version>/
directory (where <version>
is the --sdk-version
).
--sdk-version=VERSION
Determines whether to build an offline or an online version.
VERSION
may be: offline
(default) or online
.
--sdk-dev=true
Builds a development version of SDK using ../ckeditor-dev/
repository.
--sdk-pack=true
Determines whether to pack the build into a .zip
archive.
--sdk-verbose=true
Verbose mode for the building process.
grunt watch-css
Utilizes compass watch
and outputs CSS directly into the dev/ckeditor-sdk/theme/css
instead of template/theme/css
. Useful for
developing styles for a working SDK.
Note#1: Call grunt build
first. Developing CSS does not make much sense if there is no HTML.
Note#2: Produced styles are uncompressed. Also CSS<->SASS map are built.
grunt validatelinks
Validate links in samples and the main index file.
See LICENSE.md
for licensing details.