An extension of the Django Textarea widget made for editing Markdown with a live preview.
Project description
# Django Bootstrap Markdown Editor
## A beautiful Markdown editor with a side by side preview
[](https://travis-ci.org/aj-may/django-bootstrap-markdown)
[](https://coveralls.io/r/aj-may/django-bootstrap-markdown)
[](https://codeclimate.com/github/aj-may/django-bootstrap-markdown)
[](https://github.com/aj-may/django-bootstrap-markdown/blob/master/LICENSE.md)
[](https://pypi.python.org/pypi/django-bootstrap-markdown)
[](https://pypi.python.org/pypi/django-bootstrap-markdown)
[](https://www.gittip.com/aj_may/)
An extension of the Django Textarea widget made for editing [Markdown](http://daringfireball.net/projects/markdown/) with a live preview.
### Install:
`> pip install django-bootstrap-markdown`
### Usage:
* Add `django-bootstrap-markdown` to the installed apps of your Django Project
* Instead of using the django `Textarea` widget use the `MarkdownInput`
* Be sure to include the form's required media in the template. _ie._ `{{ form.media }}`
* Also be sure to include [Twitter Bootstrap](http://getbootstrap.com/)
* Include the markdown urls:
_urls.py_
urlpatterns = patterns('',
...
url(r'^markdown/', include('django_bootstrap_markdown.urls')),
...
)
### Example:
_forms.py_
from django import forms
from django_bootstrap_markdown.widgets import MarkdownInput
class PostForm(forms.Form):
title = forms.CharField()
markdown = forms.CharField( widget=MarkdownInput )
## A beautiful Markdown editor with a side by side preview
[](https://travis-ci.org/aj-may/django-bootstrap-markdown)
[](https://coveralls.io/r/aj-may/django-bootstrap-markdown)
[](https://codeclimate.com/github/aj-may/django-bootstrap-markdown)
[](https://github.com/aj-may/django-bootstrap-markdown/blob/master/LICENSE.md)
[](https://pypi.python.org/pypi/django-bootstrap-markdown)
[](https://pypi.python.org/pypi/django-bootstrap-markdown)
[](https://www.gittip.com/aj_may/)
An extension of the Django Textarea widget made for editing [Markdown](http://daringfireball.net/projects/markdown/) with a live preview.
### Install:
`> pip install django-bootstrap-markdown`
### Usage:
* Add `django-bootstrap-markdown` to the installed apps of your Django Project
* Instead of using the django `Textarea` widget use the `MarkdownInput`
* Be sure to include the form's required media in the template. _ie._ `{{ form.media }}`
* Also be sure to include [Twitter Bootstrap](http://getbootstrap.com/)
* Include the markdown urls:
_urls.py_
urlpatterns = patterns('',
...
url(r'^markdown/', include('django_bootstrap_markdown.urls')),
...
)
### Example:
_forms.py_
from django import forms
from django_bootstrap_markdown.widgets import MarkdownInput
class PostForm(forms.Form):
title = forms.CharField()
markdown = forms.CharField( widget=MarkdownInput )
