An official CKEditor 5 integration for Strapi, brought by the CKEditor team.
This package provides a custom field for Strapi that lets you use and configure CKEditor in no time.
Custom fields are supported since Strapi 4.4+ and offer powerful API to create highly customizable fields.
This is an official plugin, provided to you by the CKEditor team 👋
Inside your Strapi app, add the package:
With npm
:
npm install @ckeditor/strapi-plugin-ckeditor
With yarn
:
yarn add @ckeditor/strapi-plugin-ckeditor
Then run build:
npm run build
or:
yarn build
This section covers the way how to configure your environment if you want to contribute to this package.
In order to start making changes in the plugin you first need to install Strapi infrastructure on top of the plugin repository.
1
2
npx create-strapi-app --quickstart strapi
cd strapi
By default Strapi does not create plugins folder so we need to create it.
1
mkdir -p src/plugins
Now we should clone this repository so we can work on it.
1
git clone git@github.com:ckeditor/strapi-plugin-ckeditor.git src/plugins/strapi-plugin-ckeditor
Let's add an entry inside ./package.json
file so, we won't need to use yarn
inside plugin itself.
1
"workspaces": ["./src/plugins/strapi-plugin-ckeditor"]
Install dependencies:
1
yarn install
Now we need to register plugin so strapi can use it. In order to do that we need
to create (if not already created) ./config/plugins.js
file and add entry to it.
1
2
3
4
5
6
module.exports = ({ env }) => ({
ckeditor: {
enabled: true,
resolve: "./src/plugins/strapi-plugin-ckeditor"
},
});
Rebuild the project and start the server:
1
2
yarn build
yarn develop
npm install @ckeditor/strapi-plugin-ckeditor
Check out the available plugin resources that will help you to develop your plugin or provider and get it listed on the marketplace.