diff --git a/CHANGELOG.md b/CHANGELOG.md index 2a68e1a4b..3036e1e2d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,11 @@ Changelog ========= +## Current + +* #38: You can now boot into a development instance with `yarn start` (supports + live reload) + ## [27.1.1](https://github.com/isaul32/ckeditor5-math/compare/v27.1.0...v27.1.1) (2021-03-29) * Update dependencies for CKEditor 27.1.0 ([Release diff --git a/README.md b/README.md index eb07314f3..5d64f7e6f 100644 --- a/README.md +++ b/README.md @@ -192,3 +192,21 @@ InlineEditor.builtinPlugins = [ `.ck-reset_all *` css rules from ckeditor5-ui and ckeditor5-theme-lark break rendering in preview mode. My solution for this is use rendering element outside of CKEditor DOM and place it to right place by using absolute position. Alternative solution could be using iframe, but then typesetting engine's scripts and styles have to copy to child document. + +## Development + +Contributions, improvements and bug fixes are welcome. To aid in this, try out +our developer environment w/ live reload support and [CKEditor 5 inspector]. + +![Development environment](/screenshots/development-environment.png?raw=true "Screenshot of +development environment") + +To enter a development loop with hot reload support: + +- `git clone https://github.com/isaul32/ckeditor5-math.git` +- `cd ckeditor5-math` +- `yarn` +- `yarn start` +- http://localhost:8080 + +[CKEditor 5 inspector]: https://ckeditor.com/docs/ckeditor5/latest/framework/guides/development-tools.html#ckeditor-5-inspector diff --git a/screenshots/development-environment.png b/screenshots/development-environment.png new file mode 100644 index 000000000..e10b9a8a5 Binary files /dev/null and b/screenshots/development-environment.png differ