Name		Name	Last commit message	Last commit date
.github		.github
django_prose_editor		django_prose_editor
docs		docs
src		src
tests		tests
.editorconfig		.editorconfig
.gitattributes		.gitattributes
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
.readthedocs.yaml		.readthedocs.yaml
AGENTS.md		AGENTS.md
CHANGELOG.rst		CHANGELOG.rst
LICENSE		LICENSE
README.rst		README.rst
biome.json		biome.json
mise.toml		mise.toml
package.json		package.json
postcss.config.js		postcss.config.js
pyproject.toml		pyproject.toml
rslib.config.mjs		rslib.config.mjs
tox.ini		tox.ini
yarn.lock		yarn.lock

Repository files navigation

django-prose-editor

Prose editor for the Django admin based on ProseMirror and Tiptap. Announcement blog post.

Intro

After installing the package (using pip install django-prose-editor[sanitize]) the following should get you started:

from django_prose_editor.fields import ProseEditorField

content = ProseEditorField(
    extensions={
        "Bold": True,
        "Italic": True,
        "BulletList": True,
        "ListItem": True,
        "Link": True,
    },
    sanitize=True,  # Server side sanitization is strongly recommended.
)