Welcome to django-blocknotes’s Documentation!

Django BlockNote

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. PyPI - Version PyPI - Python Version PyPI - Versions from Framework Classifiers Documentation Status PyPI - Downloads

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

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