Skip to content

Commit

Permalink
Updated README to document used CSS custom properties. (#11)
Browse files Browse the repository at this point in the history
It's required to set these properties in order for the editor controls
to correctly render.
  • Loading branch information
carltongibson authored Aug 2, 2024
1 parent c2fcf66 commit e1de0d0
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,3 +151,17 @@ If you're rendering the form in a template you have to include the form media:

Note that the form media isn't django-prose-editor specific, that's a Django
feature.

The django-prose-editor CSS uses the following CSS custom properties, using
names that are defined in the Django admin's CSS:

* ``--border-color``
* ``--body-fg``
* ``--body-bg``
* ``--primary``

You should set these properties with appropriate values to use
django-prose-editor outside the admin in your site.

In addition, you may optionally set a ``--prose-editor-typographic`` property
to control the color of typographic characters when shown.

0 comments on commit e1de0d0

Please sign in to comment.