{"id":28633541,"url":"https://github.com/ckeditor/ckeditor4-docs","last_synced_at":"2025-06-12T15:08:46.876Z","repository":{"id":5619555,"uuid":"6827247","full_name":"ckeditor/ckeditor4-docs","owner":"ckeditor","description":"The official documentation of CKEditor 4.","archived":false,"fork":false,"pushed_at":"2025-02-05T12:42:50.000Z","size":42360,"stargazers_count":58,"open_issues_count":1,"forks_count":142,"subscribers_count":21,"default_branch":"stable","last_synced_at":"2025-03-23T13:02:23.490Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://docs.ckeditor.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ckeditor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"docs/support/extended-support-model.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-11-23T12:41:58.000Z","updated_at":"2025-02-19T10:25:28.000Z","dependencies_parsed_at":"2024-08-20T12:24:17.599Z","dependency_job_id":"179b24fb-c1d3-4646-817a-6f6a95b4769e","html_url":"https://github.com/ckeditor/ckeditor4-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ckeditor/ckeditor4-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckeditor%2Fckeditor4-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckeditor%2Fckeditor4-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckeditor%2Fckeditor4-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckeditor%2Fckeditor4-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ckeditor","download_url":"https://codeload.github.com/ckeditor/ckeditor4-docs/tar.gz/refs/heads/stable","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckeditor%2Fckeditor4-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259490549,"owners_count":22865767,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-12T15:08:46.065Z","updated_at":"2025-06-12T15:08:46.856Z","avatar_url":"https://github.com/ckeditor.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CKEditor 4 Official Documentation\n\n## ⚠️ CKEditor 4: End of Life and Extended Support Model until Dec 2028\n\nCKEditor 4 was launched in 2012 and reached its End of Life (EOL) on June 30, 2023.\n\nA special edition, **[CKEditor 4 LTS](https://ckeditor.com/ckeditor-4-support/)** (\"Long Term Support\"), is available under commercial terms ([\"Extended Support Model\"](https://ckeditor.com/ckeditor-4-support/)) for anyone looking to **extend the coverage of security updates and critical bug fixes**.\n\nWith CKEditor 4 LTS, security updates and critical bug fixes are guaranteed until December 2028.\n\n## About this repository\n\nThis is the official developer documentation project for CKEditor. It uses the customized CKEditor [JSDuck clone](https://github.com/ckeditor/jsduck) for compilation and is available online at \u003chttp://docs.ckeditor.com\u003e.\n\n**All issues regarding CKEditor 4 Documentation should be reported in the [`ckeditor4` repository](https://github.com/ckeditor/ckeditor4/issues/new/choose).**\n\n## Building the Documentation\n\nFollow the steps listed below to build CKEditor documentation locally.\n\n### Requirements\n\n* [Ruby](https://www.ruby-lang.org)\n* Java ([JRE](https://java.com) or [OpenJDK](https://openjdk.java.net))\n* [Node.js](https://nodejs.org/en)\n* [NPM](https://www.npmjs.com)\n* [grunt-cli](https://github.com/gruntjs/grunt-cli)\n* Custom CKEditor [JSDuck](https://github.com/ckeditor/jsduck) clone (installation instructions are provided below)\n\nIn order to avoid `root` privileges issues, it is advised to use [rvm](https://rvm.io/rvm/install) to manage Ruby versions and gems. In a similar manner, [nvm](https://github.com/nvm-sh/nvm) should be used to manage Node.js and npm installations. Finally, install `grunt-cli` globally with `npm i -g grunt-cli`.\n\n### Building Instructions\n\nInstructions provided below were tested on following versions of software:\n\n* ruby      v3.0.0\n* openjdk   v11.0.11\n* Node.js   v14.17.0\n* npm       v6.14.13\n* grunt-cli v1.4.2\n\nClone this repository locally:\n\n\t\u003e git clone git@github.com:ckeditor/ckeditor4-docs.git\n\nGo to the `ckeditor4-docs` directory and update the submodules:\n\n\t\u003e cd ckeditor4-docs\n\t\u003e git submodule update --init --recursive\n\nClone the custom CKEditor [JSDuck repository](https://github.com/ckeditor/jsduck) to a separate folder next to `ckeditor4-docs`:\n\n\t\u003e cd ..\n\t\u003e git clone git@github.com:ckeditor/jsduck.git\n\nCheckout the `stable` branch of the `jsduck` repository and install the latest `ckeditor-jsduck-\u003cversion\u003e.gem`:\n\n\t\u003e cd jsduck\n\t\u003e git checkout stable\n\t\u003e gem install ckeditor-jsduck-\u003cversion\u003e.gem\n\nGems versions are listed [here](https://github.com/ckeditor/jsduck#customizations). Gem installation might take a few minutes.\n\nIt may be helpfull to add `-- --with-cflags=\"-Wno-error=implicit-function-declaration\"` to gem installation command if further doc generation fails:\n\n\t\u003e gem install ckeditor-jsduck-\u003cversion\u003e.gem -- --with-cflags=\"-Wno-error=implicit-function-declaration\"\n\nGo back to the `ckeditor4-docs` repository and install [npm dependencies](package.json):\n\n\t\u003e cd ../ckeditor4-docs\n\t\u003e npm install\n\nThen finally execute `grunt build-serve`:\n\n\t\u003e grunt build-serve [--options]\n\n:warning: **Too many open files**\n\nYou might encounter such error on `umberto` task. Run `ulimit -n 65535` (or any higher value that is permitted by hard limit `ulimit -Hn`) in order to increase the limit of max open files.\n\nAvailable options:\n\n* `--dev` - use it to build documentation and view it locally,\n* `--skipApi` - skips rendering API docs,\n* `--skipValidation` - skips link validation,\n* `--clean` - when `--dev` flag is used, `--clean` enables to clear the `build` directory before outputting new documentation\n\nUse `grunt docs` to build documentation without setting a server.\n\n## API Documentation\n\nThe `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.\n\n## Using Local Versions of ckeditor4\n\nWhile the main CKEditor repository for API documents, [ckeditor4](https://github.com/ckeditor/ckeditor4), 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:\n\n * Keeping `ckeditor4-docs/` and `ckeditor4/` folders in the same directory.\n\n * Setting the `CKEDITOR_DEV_PATH` environment variable to point to your `ckeditor4/` folder path.\n\n## License\n\nSee the `LICENSE.md` file for licensing details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fckeditor%2Fckeditor4-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fckeditor%2Fckeditor4-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fckeditor%2Fckeditor4-docs/lists"}