Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fsbraun committed Dec 18, 2024
1 parent 6188a55 commit 2d79850
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,18 @@ Features

- **CKEditor5**: Look and feel of CKEditor5.
- **Inline exiting**: CKEditor5 supports inline editing.
- **Dynamic HTML attributes**: (not yet supported - help needed)
- **Dynamic HTML attributes**: Supported for the Link plugin
- **Text-enabled plugins**: (not yet supported - help needed)


Installation
------------

Install ``djangocms-text-ckeditor5`` using pip:
``pip install git+https://github.com/django-cms/djangocms-text-ckeditor5``.

.. code-block:: bash
pip install djangocms-text-ckeditor5
Build latest development branch using git:

Expand All @@ -34,19 +37,23 @@ Build latest development branch using git:
You 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:
Finally, add ``djangocms_text_ckeditor5`` in addition to ``djangocms_text`` to
your ``INSTALLED_APPS`` in your Django project settings:

.. code-block:: python
INSTALLED_APPS = [..., "djangocms_text_ckeditor5", ...]
INSTALLED_APPS = [
...,
"djangocms_text",
"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:

.. code-block:: python
INSTALLED_APPS = [..., "djangocms_text_ckeditor5", ...]
TEXT_EDITOR = "djangocms_text_ckeditor5.ckeditor5"
Expand Down

0 comments on commit 2d79850

Please sign in to comment.