Django-Markdown v. 0.8.4

Requirements

• python >= 2.7
• django >= 1.6
• 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. Models: :

   from django_markdown.models import MarkdownField
   class MyModel(models.Model):
       content = MarkdownField()
   

2. 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()
   

3. Custom admins: :

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

4. 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}}
   

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

6. Template tags: :

   <textarea id="new" name="test"></textarea>
   {% markdown_editor "#new" %}
   {% markdown_media %}
   

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

Example: settings.py :

MARKDOWN_EXTENSIONS = ['extra']

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

Examples

Execute make run in sources directory. Open 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:

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at

Contributing

Development of django-markdown happens at github:

Contributors

• klen (Kirill Klenov)
• yavorskiy (Sergii Iavorskyi)

License

Licensed under a GNU lesser general public license.

Copyright

Copyright (c) 2011 Kirill Klenov ()

Markitup:
(c) 2008 Jay Salvat