Welcome to django-blocknotes’s Documentation!

<!– {{version}} –> # Django BlockNote &nbsp; [![Release](https://codeberg.org/dunwright/django-blocknote/badges/release.svg?style=flat)](https://codeberg.org/dunwright/django-blocknote/releases) [![Version](https://img.shields.io/badge/version-2026.06.04.4-blue)](https://codeberg.org/dunwright/django-blocknote/src/branch/main/CHANGELOG.md)

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![PyPI - Version](https://img.shields.io/pypi/v/django-blocknote)](https://pypi.org/project/django-blocknote/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django-blocknote)](https://www.python.org/) [![PyPI - Versions from Framework Classifiers](https://img.shields.io/pypi/frameworkversions/django/django-blocknote)](https://docs.djangoproject.com/en/4.2/) [![Documentation Status](https://readthedocs.org/projects/django-blocknote/badge/?version=latest)](https://django-blocknote.readthedocs.io/en/latest/?badge=latest)

[![Total downloads](https://static.pepy.tech/badge/django-blocknote)](https://pepy.tech/projects/django-blocknote) [![Monthly downloads](https://static.pepy.tech/badge/django-blocknote/month)](https://pepy.tech/projects/django-blocknote) [![Weekly downloads](https://static.pepy.tech/badge/django-blocknote/week)](https://pepy.tech/projects/django-blocknote)

## Licenses

Django: BSD 3-Clause “New” or “Revised License”

BlockNote: Mozilla Public License Version 2.0

## What is django-blocknote

django-blocknote: A Powerful and Versatile Rich Text Editor for Your Django Projects

  • Seamlessly integrate BlockNote into your Django website.

  • Provide your users with a modern and intuitive content creation experience.

  • Includes features like text formatting, image uploads, tables, code blocks, and more.

  • Highly customizable to fit your project’s exact needs.

See the Quickstart: [here](https://django-blocknote.readthedocs.io/en/latest/how-to-guides/quickstart.html)

### Ideal For:

  • Blogs

  • Content Management Systems (CMS)

  • Websites requiring advanced text editing features

Includes the following BlockNote features:

### Text Formatting

Basic:

  • Bold

  • Italic

  • Underline

  • Strikethrough

  • Superscript

  • Subscript

  • Code

Paragraph and Structure:

  • BlockQuote

  • Heading

  • Paragraph

  • Alignment

Lists:

  • List

  • TodoList

  • ListProperties

Advanced:

  • Highlight

  • Indent

  • IndentBlock

### Images and Media

Core:

  • Image

  • ImageCaption

  • ImageStyle

  • ImageToolbar

  • ImageResize

  • ImageInsert

  • LinkImage

Upload:

  • UploadAdapter

  • SimpleUploadAdapter

Embedding:

  • MediaEmbed

  • HtmlEmbed

### Other

Link:

  • Link

Table:

  • Table

  • TableToolbar

Style:

  • Font

  • Style

  • HorizontalLine

Editing Tools:

  • Autoformat

Word Processing Features:

  • Mention

Overview

This documentation is organized using the Diátaxis framework, which divides documentation into four distinct types:

  • Tutorials - Learning-oriented lessons that guide you through a series of steps

  • How-to Guides - Problem-oriented directions that show you how to solve specific issues

  • Reference - Information-oriented technical descriptions of the machinery and how to operate it

  • Explanation - Understanding-oriented discussions that clarify and illuminate topics

Quick Start

New to the project? Start with our Getting Started with django-blocknote tutorial.

Need to solve a specific problem? Check our How-to Guides.

Looking for technical details? Browse the Reference.

Want to understand the bigger picture? Read our Explanation.

Indices and Tables