Skip to main content

Django markdown support and wysiwyg.

Project description

Django markdown is django application that allows use markdown wysiwyg in flatpages, admin forms and other forms. Documentaton available at pypi or github.

Build Status Coverals Version Downloads License Donate


  • python >= 2.7

  • django >= 1.6

  • markdown


Django markdown should be installed using pip:

pip install django-markdown


  • Add ‘django_markdown’ to INSTALLED_APPS

    INSTALLED_APPS += ( 'django_markdown', )
  • Add django_markdown urls to base urls

    url('^markdown/', include( 'django_markdown.urls')),

Use django_markdown

  1. Models:

    from django_markdown.models import MarkdownField
    class MyModel(models.Model):
        content = MarkdownField()
  2. Custom forms:

    from django_markdown.fields import MarkdownFormField
    from django_markdown.widgets import MarkdownWidget
    class MyCustomForm(forms.Form):
        content = forms.CharField(widget=MarkdownWidget())
        content2 = MarkdownFormField()
  3. Custom admins:

    from django_markdown.admin import MarkdownModelAdmin, MarkdownModelAdmin)
  4. Admin Overrides: (If you don’t want to subclass package ModelAdmin’s)

    from django.contrib import admin
    class YourModelAdmin(admin.ModelAdmin):
        formfield_overrides = {MarkdownField: {'widget': AdminMarkdownWidget}}
  5. Flatpages:

    # in your project main urls
    from django_markdown import flatpages
    # Django admin
    urlpatterns += [ url(r'^admin/', include(, ]
  6. Template tags:

    <textarea name="test" id="new"></textarea>
    {% markdown_editor "#new" %}
    {% markdown_media %}


MARKDOWN_EDITOR_SETTINGS - holds the extra parameters set to be passed to textarea.markItUp()

MARKDOWN_EDITOR_SKIN - skin option, default value is markitup



MARKDOWN_EXTENSIONS - optional list of extensions passed to Markdown, discussed at



MARKDOWN_EXTENSION_CONFIGS - Configure extensions, discussed at

MARKDOWN_PREVIEW_TEMPLATE - Template for preview a markdown. By default django_markdown/preview.css

MARKDOWN_STYLE - path to preview styles. By default django_markdown/preview.css

MARKDOWN_SET_PATH - path to folder with sets. By default django_markdown/sets

MARKDOWN_SET_NAME - name for current set. By default markdown.

MARKDOWN_PROTECT_PREVIEW - protect preview url for staff only


Execute make run in sources directory. Open in your browser. For admin access use ‘root:root’ credentials.


Make sure you`ve read the following document if you are upgrading from previous versions:

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at


Development of django-markdown happens at github:



Licensed under a GNU lesser general public license.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-markdown-0.8.4.tar.gz (68.5 kB view hashes)

Uploaded source

Built Distribution

django_markdown-0.8.4-py2.py3-none-any.whl (97.0 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page