Skip to main content

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

|Build Status| |Coverage Status|

An extension of the Django Textarea widget made for editing
`Markdown <http://daringfireball.net/projects/markdown/>`__ with a live
preview.

.. figure:: http://thegoods.aj7may.com/content/images/2013/Dec/Screen_Shot_2013_12_21_at_2_39_47_PM.png
:alt: Example

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

.. |Build Status| image:: https://travis-ci.org/aj7may/django-bootstrap-markdown.svg?branch=master
:target: https://travis-ci.org/aj7may/django-bootstrap-markdown
.. |Coverage Status| image:: https://coveralls.io/repos/aj7may/django-bootstrap-markdown/badge.png?branch=master
:target: https://coveralls.io/r/aj7may/django-bootstrap-markdown?branch=master

Project details


Download files

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

Source Distribution

django-bootstrap-markdown-1.8.0.tar.gz (10.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page