Martor - Django Markdown Editor

Martor is a comprehensive Markdown Editor plugin for Django, designed to provide a powerful and user-friendly markdown editing experience with support for both Bootstrap and Semantic-UI frameworks.

Features

📝 Live Preview - Real-time markdown rendering
⚡ Ace Editor Integration - Powerful code editor with syntax highlighting
🎨 Dual Theme Support - Bootstrap and Semantic-UI compatible
📤 Image Upload - Direct upload to imgur.com or custom endpoints
👥 User Mentions - Direct mention users with @[username] syntax
🎬 Video Embedding - Embed videos from YouTube, Vimeo, and more
✅ Spellcheck - Built-in spell checking (US English)
😀 Emoji Support - Full emoji support with cheat sheets
🔧 Django Admin Integration - Seamless admin interface integration
🛡️ Security Features - XSS protection and HTML sanitization
🔗 Custom ID Support - Add custom IDs to text elements
🧩 Extensible - Custom markdown extensions support

Quick Start

Installation:

pip install martor

Add to your Django settings:

INSTALLED_APPS = [
    ...
    'martor',
]

Include Martor URLs:

urlpatterns = [
    ...
    path('martor/', include('martor.urls')),
]

Collect static files:

python manage.py collectstatic

Usage in your models:

from martor.models import MartorField

class Post(models.Model):
    content = MartorField()

That’s it! You now have a powerful markdown editor in your Django application.

Documentation Contents

User Guide

API Reference

Fields API Reference

Examples & Tutorials

Basic Examples

Help & Support

Screenshots

Martor Editor Interface:

Live Preview:

Community & Support

GitHub: https://github.com/agusmakmun/django-markdown-editor
PyPI: https://pypi.org/project/martor/
Issues: https://github.com/agusmakmun/django-markdown-editor/issues
Wiki: https://github.com/agusmakmun/django-markdown-editor/wiki

License

Martor is released under the GNU General Public License v3.0.