CKEditor 5 editor generated with the online builder for Hardocs

This repository presents a CKEditor 5 editor build generated by the Online builder tool

Configuring build

Changes like changing toolbar items, changing order of icons or customizing plugin configurations should be relatively easy to make. Open the sample/index.html file and edit the script that initialized the CKEditor 5. Save the file and refresh the browser. That's all.

Note: If you have any problems with browser caching use the Ctrl + R or Cmd + R shortcut depending on your system.

However if you want to remove or add a plugin to the build you need to follow the next step of this guide.

Note that it is also possible to go back to the Online builder tool and pick other set of plugins. But we encourage you to try the harder way and to learn the principles of Node.js and CKEditor 5 ecosystems that will allow you to do more cool things in the future!

Installation

In order to rebuild the application you need to install all dependencies first. To do it, open the terminal in the project directory and type:

yarn
  # or
npm install

Make sure that you have the node and npm installed first. If not, then follow the instructions on the Node.js documentation page.

Adding or removing plugins

Now you can install additional plugin in the build. Just follow the Adding a plugin to an editor tutorial

Rebuilding editor

If you have already done the Installation and Adding or removing plugins steps, you're ready to rebuild the editor by running the following command:

yarn build
  #or
npm run build

This will build the CKEditor 5 to the build directory.

What's next?

Follow the guides available on https://ckeditor.com/docs/ckeditor5/latest/framework/index.html and enjoy the document editing.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Divine Hycenth 📖

This project follows the all-contributors specification. Contributions of any kind welcome!