Notes/docs/Developer Guide/Developer Guide/Old documentation/Sub-projects/ckeditor5-math.md

ckeditor5-math

ckeditor5-math in action.

A fork of isaul32/ckeditor5-math, which is the CKEditor5 plugin which adds the math functionality. The fork was created to handle #297: Insert Math appears to be broken.

Development environment

• Tested on Node.js 20.
• The package manager is yarn 1 (v1.22.22 is known to be working fine for it at the time of writing).

Important commands:

• To check if the code has any formatting issues: yarn lint
• To start a live preview: yarn start
• To run the tests: yarn test
  • Note that this requires Chromium, on NixOS this can be achieved by running a nix-shell -p chromium, and running CHROME_BIN=$(which chromium) yarn test inside it.

📦 Packages

The built artifact of the plugin is released by the CI and available on the GitHub NPM registry.

Note that due to limitations on GitHub's registry, it is not possible to install this package without setting up a personal access token (even though the package itself is public). See [missing note] for more information.

⬆️ Integrating with CKEditor

1. Release a new version: Release management & continuous integration
2. In trilium-ckeditor5, go to packages/ckeditor5-build-trilium/package.json in the CKEditor repository and change the dependency of @triliumnext/ckeditor5-math to the newly released version.
3. Run yarn install.
4. Proceed with Building the editor to integrate everything into TriliumNext and then commit the change.