Skip to content

Latest commit

 

History

History
206 lines (124 loc) · 5.05 KB

README.rst

File metadata and controls

206 lines (124 loc) · 5.05 KB
Raw

Django-Markdown v. 0.8.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 Coverals Version Downloads License Donate

Contents

Requirements

  • python >= 2.7
  • django >= 1.6
  • 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. 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 name="test" id="new"></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 https://pythonhosted.org/Markdown/extensions/index.html#officially-supported-extensions

Example: settings.py

MARKDOWN_EXTENSIONS = ['extra']

MARKDOWN_EXTENSION_CONFIGS - Configure extensions, discussed at https://pythonhosted.org/Markdown/reference.html#extension_configs

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 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

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/