hazho / django-ckeditor5

Integration of CKEditor 5 with Django

Django CKEditor 5

• Introduction
• Installation

Introduction

Django CKEditor 5 integrates CKEditor 5 with Django. The purpose of this package is the same as that of the original django-ckeditor except that we use CKEditor 5 while the original package uses CKEditor 4.

According to ckeditor.com:

When compared to its predecessor, CKEditor 5 should be considered a totally new editor.

The implementation follows the structure of ckeditor in django-ckeditor. So the usage should be very similar. The differences are:

• static/ckeditor5 contains the build of the classic ckeditor 5 v11.0.1. It was downloaded as a zip file from CKEditor 5's download page.
• There is no extraPlugins in CKEditor 5. So the codes (in python, html, javascript) related to external plugins or external plugin resources are removed.
• static/ckeditor5/ckeditor-init.js is modified. In the initialiseCKEditor function:
  • The part that handles external plugins configuration is removed.
  • Instead of CKEDITOR.replace, CKEditor 5 uses ClassicEditor.create to initialize/create an editor.

Installation