{"id":28381845,"url":"https://github.com/opf/commonmark-ckeditor-build","last_synced_at":"2025-06-25T04:31:20.335Z","repository":{"id":37405706,"uuid":"120757569","full_name":"opf/commonmark-ckeditor-build","owner":"opf","description":"CKEditor5 build with CommonMark formatter for OpenProject - @openproject/commonmark-ckeditor-build","archived":false,"fork":false,"pushed_at":"2025-04-22T06:59:55.000Z","size":1788,"stargazers_count":5,"open_issues_count":1,"forks_count":7,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-06-22T00:57:49.425Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":false,"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/opf.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":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-02-08T12:17:43.000Z","updated_at":"2025-04-22T06:59:58.000Z","dependencies_parsed_at":"2024-02-19T22:24:30.663Z","dependency_job_id":"3da11545-1960-4b82-861e-2e8f8c0011c3","html_url":"https://github.com/opf/commonmark-ckeditor-build","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/opf/commonmark-ckeditor-build","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opf%2Fcommonmark-ckeditor-build","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opf%2Fcommonmark-ckeditor-build/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opf%2Fcommonmark-ckeditor-build/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opf%2Fcommonmark-ckeditor-build/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opf","download_url":"https://codeload.github.com/opf/commonmark-ckeditor-build/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opf%2Fcommonmark-ckeditor-build/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261805087,"owners_count":23212296,"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-05-30T04:06:33.598Z","updated_at":"2025-06-25T04:31:20.320Z","avatar_url":"https://github.com/opf.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenProject CKEditor5 build repository\n\nThis repository acts as a separated source for the custom CKEditor5 builds referenced in OpenProject.\n\n\n[https://github.com/opf/openproject](https://github.com/opf/openproject)\n\n[https://github.com/ckeditor/ckeditor5](https://github.com/ckeditor/ckeditor5)\n\n\n\n1. Install the dependencies\n\n```\n# In this repository's root (commonmark-ckeditor-build)\nnpm install\n```\n\n2. Reference the link in OpenProject\n\n```\nexport OPENPROJECT_CORE=/path/to/openproject/root\n```\n\n\n\n## Building\n\n\n\nBuilding into the core is easy, just run\n\n`npm run build`\n\n\n\nThis will override the `app/assets/javascripts/vendor/ckeditor/*` contents with the newest webpack build. You need to run this before opening a pull request.\n\nPlease also ensure you always create a pull request on this repository that gets merged whenever the core counterpart gets merged to ensure the master of this branch is always the latest built version in OpenProject\n\n\n\n### Updating CKEditor\n\nWhenever a new CKEditor release is made, there are a plethora of packages to be updated. The easiest is to use [npm-check-updates](https://www.npmjs.com/package/npm-check-updates) to update all dependencies in the package.json and then rebuild + run openproject tests.\n\n\n\n### Patch for ckeditor5-mention plugin\n\nWe use `patch-package` (https://www.npmjs.com/package/patch-package) to store a patch for the ckeditor5-mention plugin to ensure multiple-hash mentions for work packages (e.g., `###2134`) work correctly. See https://community.openproject.org/work_packages/47084 for context.\n\n\n\n## Development\n\n- Run `npm run watch`\n\nNow the webpack development mode is building the files and outputting them to `app/assets/javascripts/vendor/ckeditor/*`, overriding anything in there.\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopf%2Fcommonmark-ckeditor-build","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopf%2Fcommonmark-ckeditor-build","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopf%2Fcommonmark-ckeditor-build/lists"}