Django markdown support and wysiwig
Pull request Compare This branch is 1 commit ahead, 143 commits behind klen:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
django_markdown
docs
.gitignore
ChangeLog.txt
DESCRIPTION
LICENSE
MANIFEST.in
Makefile
README
README.rst
setup.py
todo.txt

README.rst

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

Settings

MARKDOWN_SKIN - skin option, default value is markitup

Example: settings.py

MARKDOWN_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 of scss:

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

License

Licensed under a GNU lesser general public license.

Copyright

Copyright (c) 2011 Kirill Klenov (horneds@gmail.com)

Markitup_:
(c) 2008 Jay Salvat http://markitup.jaysalvat.com/