Table Of Contents

This Page

django-markdown

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

Requirements

  • python >= 2.5
  • django >= 1.2
  • markdown

Installation

Django markdown should be installed using pip:

pip install django-markdown

Setup

  • 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. Custom forms:

    from django_markdown.widgets import MarkdownWidget
    class MyCustomForm(forms.Form):
        content = forms.CharField( widget=MarkdownWidget() )
    
  2. Custom admins:

    from django_markdown.admin import MarkdownModelAdmin
    adimin.site.register(MyModel, MarkdownModelAdmin)
    
  3. Flatpages:

    # in your project main urls
    from django_markdown import flatpages
    ...
    # Django admin
    admin.autodiscover()
    flatpages.register()
    urlpatterns += [ url(r'^admin/', include(admin.site.urls)), ]
    
  4. JavaScript API:

    // Editors manager ``miu`` methods
    
    // Initialize editor using default settings extended with ``extraSettings``
    miu.init(textareaId, extraSettings);
    
    // Get default mIu settings
    miu.settings();
    
    // Set default mIu settings
    miu.settings(newSettings);
    
    // Get all initialized aditors
    miu.editors();
    
    // Get certain editor
    miu.editors(textareaId);
    
    
    // Editor instance methods
    
    // Dynamically add button at ``index`` position
    editor.addButton(conf, index)
    
    // Dynamically remove button at ``index`` position
    editor.removeButton(index)
    

Settings

MARKDOWN_EDITOR_SKIN - skin option, default value is markitup

Example: settings.py

MARKDOWN_EDITOR_SKIN = 'simple'

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

Changes

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

http://packages.python.org/django-markdown/changes.html

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/django_markdown/issues

Contributing

Development of django-markdown happens at github: https://github.com/klen/django_markdown

Contributors