https://github.com/opf/commonmark-ckeditor-build
CKEditor5 build with CommonMark formatter for OpenProject - @openproject/commonmark-ckeditor-build
https://github.com/opf/commonmark-ckeditor-build
Last synced: 7 months ago
JSON representation
CKEditor5 build with CommonMark formatter for OpenProject - @openproject/commonmark-ckeditor-build
- Host: GitHub
- URL: https://github.com/opf/commonmark-ckeditor-build
- Owner: opf
- License: other
- Created: 2018-02-08T12:17:43.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-22T06:59:55.000Z (9 months ago)
- Last Synced: 2025-06-22T00:57:49.425Z (7 months ago)
- Language: JavaScript
- Size: 1.71 MB
- Stars: 5
- Watchers: 11
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# OpenProject CKEditor5 build repository
This repository acts as a separated source for the custom CKEditor5 builds referenced in OpenProject.
[https://github.com/opf/openproject](https://github.com/opf/openproject)
[https://github.com/ckeditor/ckeditor5](https://github.com/ckeditor/ckeditor5)
1. Install the dependencies
```
# In this repository's root (commonmark-ckeditor-build)
npm install
```
2. Reference the link in OpenProject
```
export OPENPROJECT_CORE=/path/to/openproject/root
```
## Building
Building into the core is easy, just run
`npm run build`
This will override the `app/assets/javascripts/vendor/ckeditor/*` contents with the newest webpack build. You need to run this before opening a pull request.
Please 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
### Updating CKEditor
Whenever 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.
### Patch for ckeditor5-mention plugin
We 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.
## Development
- Run `npm run watch`
Now the webpack development mode is building the files and outputting them to `app/assets/javascripts/vendor/ckeditor/*`, overriding anything in there.