skip to navigation
skip to content

Not Logged In

django-markdown 0.2.5

Django markdown support and wysiwyg.

Package Documentation

Latest Version: 0.5.4

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 Coveralls Version Downloads Donate

Requirements

  • python >= 2.6
  • django >= 1.4
  • markdown

Installation

Django markdown should be installed using pip:

pip install django-markdown

Setup

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

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

Settings

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

MARKDOWN_EDITOR_SKIN - skin option, default value is markitup

Example: settings.py

MARKDOWN_EDITOR_SKIN = 'simple'

MARKDOWN_EXTENSIONS - optional list of extensions passed to Markdown, discussed at https://pythonhosted.org/Markdown/extensions/index.html#officially-supported-extensions

Example: settings.py

MARKDOWN_EXTENSIONS = ['extra']

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.

Examples

Execute make run in sources directory. Open http://127.0.0.1:8000 in your browser. For admin access use 'root:root' credentials.

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

 
File Type Py Version Uploaded on Size
django-markdown-0.2.5.tar.gz (md5) Source 2014-02-25 63KB
  • Downloads (All Versions):
  • 114 downloads in the last day
  • 445 downloads in the last week
  • 2376 downloads in the last month