djangocms-text-ckeditor5 is an extension to djangocms-text offering CKEditor5 as
a rich text editor to djangocms-text.
- CKEditor5: Look and feel of CKEditor5.
- Inline exiting: CKEditor5 supports inline editing.
- Dynamic HTML attributes: (not yet supported - help needed)
- Text-enabled plugins: (not yet supported - help needed)
Install djangocms-text-ckeditor5 using pip:
pip install git+https://github.com/django-cms/djangocms-text-ckeditor5.
Build latest development branch using git:
git clone [email protected]:django-cms/djangocms-text-ckeditor5.git
cd djangocms-text-ckeditor5
nvm use
npm install
npx webpack --mode developmentYou then can install the cloned repo using pip install -e
/path/to/the/repo/djangocms-text-ckeditor5.
Finally, add djangocms_text_ckeditor5 to your INSTALLED_APPS in your Django project
settings:
INSTALLED_APPS = [..., "djangocms_text_ckeditor5", ...]Add an editor frontend to your installed apps (if different from the default TipTap frontend), and set the editor you want to use:
INSTALLED_APPS = [..., "djangocms_text_ckeditor5", ...]
DJANGOCMS_TEXT_EDITOR = "djangocms_text_ckeditor5.ckeditor5"Contributions to djangocms-text-ckeditor5 are welcome! Please read our contributing guidelines to get started.
The CKEditor 5 and this package are licensed under the GPL-2.0 License.