Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

Django markdown support and wysiwyg.

Project description

Author: Kirill Klenov
Maintainer: Slavik Svyrydiuk
License: GNU LGPL
Description: Django-Markdown v. 0.9.6

.. _description:

**Django markdown** is django application that allows use markdown_ wysiwyg in flatpages, admin forms and other forms.
Documentaton available at readthedocs_ or github_.

.. _badges:

.. image::
:alt: Build Status

.. image::
:alt: Coverals

.. image::
:alt: Version

.. image::
:alt: License

.. contents::

.. _requirements:


- django >= 2.0
- markdown >= 2.6.11

.. _installation:


**Django markdown** should be installed using pip: ::

pip install django-markdown-app

Version compatibility

Starting with version, django-markdown-app requires Django 2.0 or later.

============== ===================
Django version django-markdown-app
============== ===================
2.0 or later 0.9.6
1.8 or later
prior to 1.8
============== ===================


.. note:: 'django_markdown' require 'django.contrib.staticfiles' in INSTALLED_APPS

- Add 'django_markdown' to INSTALLED_APPS ::

INSTALLED_APPS += ( 'django_markdown', )

- Add django_markdown urls to base urls ::

path('markdown/', include( 'django_markdown.urls')),

Use django_markdown

#) Models: ::

from django_markdown.models import MarkdownField

class MyModel(models.Model):
content = MarkdownField()

#) 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()

#) Custom admins: ::

from django_markdown.admin import MarkdownModelAdmin, MarkdownModelAdmin)

#) 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}}

#) Flatpages: ::

# in your project main urls
from django_markdown import flatpages
# Django admin
urlpatterns += [ path(r'admin/',, ]

#) 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``

Example: `` ::


**MARKDOWN_EXTENSIONS** - optional list of extensions passed to Markdown.

Officially supported extensions could be found

Example: `` ::


**MARKDOWN_EXTENSION_CONFIGS** - configure extensions

**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 changes_ document if you are upgrading from previous version.

Bug tracker

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


Development of django-markdown happens at github:


* klen_ (Kirill Klenov)

* yavorskiy_ (Sergii Iavorskyi)


Licensed under a `GNU lesser general public license`_.


Copyright (c) 2011 Kirill Klenov (

(c) 2008 Jay Salvat

.. _GNU lesser general public license:
.. _readthedocs:
.. _Markitup:
.. _github:
.. _klen:
.. _yavorskiy:
.. _markdown:
.. _changes:

Keywords: html markdown django
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django :: 2.0
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Text Processing :: Markup

Project details

Download files

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

Files for django-markdown-app, version 0.9.6
Filename, size File type Python version Upload date Hashes
Filename, size django_markdown_app-0.9.6-py2.py3-none-any.whl (97.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size django-markdown-app-0.9.6.tar.gz (72.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page