Skip to main content

Django markdown support and wysiwyg.

Project description

Author: Tomas Garzon
License: GNU LGPL
Description: Django-Markdown v. 0.8.4

.. _description:

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

.. _badges:

.. image::
:alt: Build Status

.. image::
:alt: Coverals

.. image::
:alt: Version

.. image::
:alt: Downloads

.. image::
:alt: License

.. image::
:alt: Donate

.. contents::

.. _requirements:


- python >= 2.7
- django >= 1.6
- markdown

.. _installation:


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

pip install django-markdown


.. 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 ::

url('^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 += [ url(r'^admin/', include(, ]

#) 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, discussed at

Example: `` ::


**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


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:
.. _pypi:
.. _Markitup:
.. _github:
.. _klen:
.. _yavorskiy:

Keywords: html markdown django
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Classifier: Programming Language :: Python
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.

Source Distribution

django2-markdown-0.8.6.tar.gz (68.4 kB view hashes)

Uploaded source

Built Distribution

django2_markdown-0.8.6-py2.py3-none-any.whl (96.1 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