Skip to content

Commit

Permalink
Also mention the list nodes in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
matthiask committed Aug 2, 2024
1 parent 756f64d commit aa3b190
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,21 @@ If this does not seem convincing you can always add your own rich text plugin wi
Installation
~~~~~~~~~~~~

Install the package:
The first step is to ensure that you have an activated virtualenv for your
current project, using something like ``. .venv/bin/activate``.

Install the package into your environment:

.. code-block:: shell
venv/bin/pip install django-prose-editor
pip install django-prose-editor
To include nh3 as optional dependency for sanitized HTML, install the extra
"sanitize":

.. code-block:: shell
venv/bin/pip install django-prose-editor[sanitize]
pip install django-prose-editor[sanitize]
Add ``django_prose_editor`` to ``INSTALLED_APPS``:

Expand Down Expand Up @@ -116,7 +119,8 @@ tags, that's out of scope for now.
``doc``, ``paragraph`` and ``text`` are always in the allowlist.

The supported node types are ``heading``, ``blockquote``, ``horizontal_rule``
and ``hard_break``.
and ``hard_break``. List nodes are ``ordered_list``, ``bullet_list`` and
``list_item``.

The supported mark types are ``link``, ``strong``, ``em``, ``underline``,
``strikethrough``, ``sub`` and ``sup``
Expand Down

0 comments on commit aa3b190

Please sign in to comment.