README

This Drupal 9+ module contains a collection of CKEditor 5 plugins to add functionality to the WYSIWYG editor.

Useful Plugin Development Links

• CKEditor 5 Dev Tools for Drupal
  • Necessary for building plugins
  • Demo plugin is provided within the module as well
  • Read through the readmes of the demo plugin
• Drupal 10 launched: taking content editing to the next level with CKEditor 5
• USERS & EDITORS - CKEditor 5 in Drupal 10: what is there to be excited about? (31 minutes in)
  • This is a good video to watch. It gives the basic structural information behind CKEditor plugins
• CKEditor 5 Plugin Example Guide
  • There are three parts to this guide. Each part slowly builds on the last. I recommend building it but keep in mind that pathing for imports will be different for Drupal
• webpack.config.js Loaders
  • The SVG loader is needed for icon rendering. The CSS and JS loaders are only needed if you are using attempting CKEditor's built in CSS/SASS or JS functions
  • If used you will need to remove the 'include' lines as they break Drupal pathing
• Plugin Post Update Hook
  • What we use to make sure that our plguins' tags are appended to the 'allowed_html' options of our wysiwyg editor format filter.
• CKEditor 5 Plugin Development - Build from Source
  • This is useful for getting better error messages when doing active plugin development.
  • Following the docs, you'll also need to link @ckeditor/ckeditor5-alignment in addition to the packages in the tutorial