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.

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

Models:

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

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

Custom admins:

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

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

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

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

klen (Kirill Klenov)
yavorskiy (Sergii Iavorskyi)

License

Licensed under a GNU lesser general public license.

Copyright

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

Release files for django-markdown 0.8.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-markdown 0.8.4
File	Size	Uploaded
django-markdown-0.8.4.tar.gz	68.5 kB	Dec 14, 2014	Details

Built distribution (wheel)

Table of built distributions (wheels) for django-markdown 0.8.4
File	Interpreter	ABI	Platform	Reset
django_markdown-0.8.4-py2.py3-none-any.whl 97.0 kB Dec 14, 2014	Python 3, Python 2	none	any	Details

Total release size: 165.6 kB

Release files / django-markdown-0.8.4.tar.gz

Download URL	django-markdown-0.8.4.tar.gz
Size	68.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`bab6719cac47c7139c9f489816a99fd656caa56d364a2b7d2137db698219b402`
BLAKE2b-256 checksum How to use checksums	`130912aa1b161620da511bdde3b664d8d6479d42e18d04d34d64f82f384dbf37`
Upload date	Dec 14, 2014
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / django_markdown-0.8.4-py2.py3-none-any.whl

Download URL	django_markdown-0.8.4-py2.py3-none-any.whl
Size	97.0 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`118d3a3b0dda0279785c007720fe594ccf9fa4cc1d6cee878bb81d36a02dd668`
BLAKE2b-256 checksum How to use checksums	`21fbdd7837fdf86012a657df79aea607a2d701e89c5549342c2bb74b33cb6219`
Upload date	Dec 14, 2014
Uploaded using Trusted Publishing? What is trusted publishing?	No