Using the package generator
ckeditor5-package-generator is a tool for developers. It creates a working package with the development environment that allows writing new custom plugins for CKEditor 5.
# Quick start
To create a new package without installing the tool, simply execute the following command:
npx ckeditor5-package-generator <packageName> [--use-npm] [--use-yarn] [--plugin-name <...>] [--verbose] [--lang <js|ts>]
<packageName> argument is required and must obey these rules:
- The provided name must match the schema:
@scope/ckeditor5-*, where @scope is the owner of the package.
- The package name must start with the
- Allowed characters are numbers (
0-9), lowercase letters (
a-z) and symbols:
As a result of executing the command, a new directory with a package in it will be created. The directory’s name will be equal to the specified package name without the
@scope part, and it will contain an example plugin and the development environment.
Available modifiers for the command are:
npmto install dependencies in the newly created package.
yarnto install dependencies in the newly created package.
--plugin-name– define the plugin name to be different from the package name.
-v) print additional logs about the current executed task.
# Using the package
After successfully creating a directory with the new package, enter it by executing the following command:
# Assuming that your package was created with `ckeditor5-foo` as its name. cd ckeditor5-foo
Then, run the test environment for the plugin by executing the following command:
npm run start
Now the plugin can be seen within the example editor.
You can check out what is available inside your package depending on the language you used:
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.