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.

Contents

django-markdown

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 ¶

Custom forms:

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

Custom admins:

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

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)), ]

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)