CKEditor 5 rich text editor component for React
Official CKEditor 5 rich text editor component for React.
- Quick start
- Integrating CKEditor 5 built from source
After cloning this repository, install necessary dependencies:
You can also use Yarn.
Before starting tests execution, you need to build the package. You can use
npm run build in order to build the production-ready version
npm run develop which produces a development version with attached watcher for all sources files.
npm run test -- [additional options] # or npm t -- [additional options]
The command accepts the following options:
-c) – Whether to generate the code coverage.
-s) – Whether to attach the source maps.
-w) – Whether to watch test files.
-r) – Reporter for Karma (default:
mocha, can be changed to
-b) – Browsers that will be used to run tests (default:
Building the package
Build a minified version of the package that is ready to publish:
npm run build
Before starting the release process, you need to generate the changelog:
npm run changelog
After generating the changelog, you are able to release the package.
First, you need to bump the version:
npm run release:bump-version
You can also use the
--dry-run option in order to see what this task does.
After bumping the version, you can publish the changes:
npm run release:publish
As in the previous task, the
--dry-run option is also available.
Note: Only the
dist/ directory will be published.
Licensed under the terms of GNU General Public License Version 2 or later. For full details about the license, please check the LICENSE.md file.