django-unfold-markdown 0.1.2

Markdown editor widget for Django Unfold admin

Django Unfold Markdown Widget

Markdown editor widget for Django Unfold admin using EasyMDE.

Screenshots

Editor with Preview

Fullscreen Mode

Editor inside tab and Dark theme

Features

• Plain text editor with monospace font
• Side-by-side preview and fullscreen modes
• Dark/light theme integration with Unfold
• Material Symbols icons matching Unfold design
• Toolbar: bold, italic, strikethrough, headings, lists, links, images, tables, horizontal rules
• No autosave (saves on form submit)
• Responsive design

Installation

pip install django-unfold-markdown

Configuration

Add to your INSTALLED_APPS:

# settings.py
INSTALLED_APPS = [
    "unfold",
    "unfold_markdown",  # Add this
    # ...
]

Usage

For all TextField fields

# admin.py
from django.db import models
from unfold.admin import ModelAdmin
from unfold_markdown.widgets import MarkdownWidget

@admin.register(Article)
class ArticleAdmin(ModelAdmin):
    formfield_overrides = {
        models.TextField: {"widget": MarkdownWidget}
    }

For specific fields

from django import forms
from unfold_markdown.widgets import MarkdownWidget

class ArticleForm(forms.ModelForm):
    content = forms.CharField(widget=MarkdownWidget())
    
    class Meta:
        model = Article
        fields = '__all__'

@admin.register(Article)
class ArticleAdmin(ModelAdmin):
    form = ArticleForm

Storage and Rendering

The widget stores pure Markdown text in your database. To render Markdown as HTML, use a Python library:

# Using markdown
from markdown import markdown
html = markdown(article.content)

# Using mistune
import mistune
html = mistune.html(article.content)

Requirements

• Python ≥ 3.10
• Django ≥ 4.2
• django-unfold ≥ 0.70.0

License

MIT License

Repository

https://github.com/sergei-vasilev-dev/django-unfold-markdown

Credits

• EasyMDE: Ionaru/easy-markdown-editor (MIT License)
• Django Unfold: unfoldadmin/django-unfold (MIT License)