⚠️ This repository contains the CKEditor 5 component for Vue.js 3+
. The component for lower Vue.js versions is located in another repository - @ckeditor/ckeditor5-vue2.
Official CKEditor 5 rich text editor component for Vue.js.
See the "Rich text editor component for Vue.js" guide in the CKEditor 5 documentation to learn more:
After cloning this repository, install necessary dependencies:
npm install
You can also use Yarn.
To manually test the editor integration, you can start the development server using one of the commands below:
npm run dev
To test the editor integration against a set of automated tests, run the following command:
npm run test
If you want to run the tests in watch mode, use the following command:
npm run test:watch
To build the package that is ready to publish, use the following command:
npm run build
The release process is automated via CircleCI and it can release both channels: stable (X.Y.Z
) and pre-releases (X.Y.Z-alpha.X
, etc.).
Before you start, you need to prepare the changelog entries.
#master
branch is up-to-date: git fetch && git checkout master && git pull
.git checkout -b release-[YYYY-MM-DD]
where YYYY-MM-DD
is the current day.yarn run changelog --branch release-[YYYY-MM-DD] [--from [GIT_TAG]]
.
--from
modifier option allows overriding the default behavior. It is required when preparing the changelog entries for the next stable release while the previous one was marked as a prerelease, e.g., @alpha
.
Example: Let's assume that the v40.5.0-alpha.0
tag is our latest and that we want to release it on a stable channel. The --from
modifier should be equal to --from v40.4.0
.#master
branch.@ckeditor/ckeditor-5-devops
team to review the pull request and trigger the release process.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.