django-markdown

Django markdown support and wysiwyg.

Project description

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

Custom forms:

from django_markdown.widgets import MarkdownWidget
class MyCustomForm(forms.Form):
    content = forms.CharField(widget=MarkdownWidget())

Custom admins:

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

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/

Project details

Release history Release notifications | RSS feed

0.8.4

Dec 14, 2014

0.8.3

Dec 14, 2014

0.8.1

Dec 6, 2014

0.8.0

Nov 26, 2014

This version

0.7.1

Oct 6, 2014

0.7.0

Sep 25, 2014

0.6.1

Jun 4, 2014

0.6.0

May 18, 2014

0.5.4

Feb 27, 2014

0.4.0

Feb 26, 2014

0.3.0

Feb 26, 2014

0.2.5

Feb 25, 2014

0.2.4

Feb 21, 2014

0.2.3

Feb 15, 2014

0.2.2

Feb 8, 2014

0.2.1

May 9, 2013

0.2.0

Dec 14, 2012

0.1.0

Mar 11, 2011

0.0.9

Mar 7, 2011

0.0.8

Mar 7, 2011

0.0.7

Mar 7, 2011

0.0.6

Mar 7, 2011

0.0.5

Mar 6, 2011

0.0.4

Feb 2, 2011

0.0.3

Feb 2, 2011

0.0.2

Feb 2, 2011

0.0.1

Feb 2, 2011

0.0.0

Feb 25, 2014

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-markdown-0.7.1.tar.gz (67.2 kB view details)

Uploaded Oct 6, 2014 Source

Built Distribution

django_markdown-0.7.1-py2.py3-none-any.whl (94.6 kB view details)

Uploaded Oct 6, 2014 Python 2 Python 3

File details

Details for the file django-markdown-0.7.1.tar.gz.

File metadata

Download URL: django-markdown-0.7.1.tar.gz
Upload date: Oct 6, 2014
Size: 67.2 kB
Tags: Source
Uploaded using Trusted Publishing? No

File hashes

Hashes for django-markdown-0.7.1.tar.gz
Algorithm	Hash digest
SHA256	`f1f56b736084a640391940211539706acdaf63418985088aa64183ea5c16a70e`
MD5	`dfaf05d5cb20b7f435a45add3466c967`
BLAKE2b-256	`6a8182c21705c97904028cddc2615f3ef15c6e9d4694ef38627765ba2ba8650f`

See more details on using hashes here.

File details

Details for the file django_markdown-0.7.1-py2.py3-none-any.whl.

File metadata

Download URL: django_markdown-0.7.1-py2.py3-none-any.whl
Upload date: Oct 6, 2014
Size: 94.6 kB
Tags: Python 2, Python 3
Uploaded using Trusted Publishing? No

File hashes

Hashes for django_markdown-0.7.1-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`b582dfc3bf16c5495ac7941fee8790f3663edb4db59f626818f1a9a6b1d8138e`
MD5	`578026b86c6429d717d6ec0d6c48ea2b`
BLAKE2b-256	`2c35c3ee80f544565ebe1f083e9de89ae874af17234f760293d988da885f768c`