skip to navigation
skip to content

Not Logged In

django-pagedown 0.0.5

A django app that allows the easy addition of Stack Overflow's 'PageDown' markdown editor to a django form field

Latest Version: 0.1.0

Django Pagedown
===============

A django app that allows the easy addition of [Stack Overflow's "Pagedown" Markdown editor](http://code.google.com/p/pagedown/) to a django form field, whether in a custom app or the Django Admin

---

![Screenshot of Django Admin with Pagedown initialised](https://github.com/timmyomahony/django-pagedown/blob/master/django-pagedown-screenshot.png?raw=true "A screenshot of Pagedown in Django's admin")

---

#### Installation ####

1. Get the code: `pip install django-pagedown`
2. Add `pagedown` to your `INSTALLED_APPS`
3. Make sure to collect the static files: `python manage.py collectstatic --noinput`

Note that this package will install a cloned copy (git submodule)of the Pagedown library from [http://github.com/timmyomahony/pagedown/](http://github.com/timmyomahony/pagedown/).

If you don't like (or are having problems with) PyPi, you can alternatively install:

 - Via pip from GitHub: `pip install -e https://timmyomahony@github.com/timmyomahony/django-pagedown.git#egg=django-pagedown`
 - Manually clone from Github:
     - `git clone https://timmyomahony@github.com/timmyomahony/django-pagedown.git`
     - `cd django-pagedown`
     - `git submodule update --init`

---

#### Usage ####

**Inside the Django Admin:**

If you want to use the pagedown editor in a django admin field, there are numerous possible approaches:

To use it in **all** `TextField`'s in you admin form:

    from pagedown.widgets import AdminPagedownWidget
    from django.db import models


    class FooModelAdmin(models.ModelAdmin):
        formfield_overrides = {
                models.TextField: {'widget': AdminPagedownWidget },
        }

Alternatively, to only use it on particular fields, first create a form (in `forms.py`):

    from pagedown.widgets import AdminPagedownWidget
    from django import forms
    from models import FooModel


    class FooModelForm(forms.ModelForm):
        a_text_field = forms.CharField(widget=AdminPagedownWidget())
        another_text_field = forms.CharField(widget=AdminPagedownWidget())

        class Meta:
            model = FooModel

and in your `admin.py`:

    from forms import FooModelForm
    from models import FooModel
    from django.contrib import admin


    class FooModelAdmin(admin.ModelAdmin):
        form = FooModelForm

    admin.site.register(FooModel, FooModelAdmin)

**Outside the Django Admin:**

To use the widget outside of the django admin, first create a form similar to the above but using the basic `PagedownWidget`:

    from pagedown.widgets import PagedownWidget
    from django import forms
    from models import FooModel


    class FooModelForm(forms.ModelForm):
        a_text_field = forms.CharField(widget=PagedownWidget())
        another_text_field = forms.CharField(widget=PagedownWidget())

        class Meta:
            model = FooModel


Then define your urls/views:

    from forms import FooModelForm
    from django.views.generic import FormView
    from django.conf.urls import patterns, url

    urlpatterns = patterns('',
        url(r'^$', FormView.as_view(
            template_name="baz.html",
            form_class=FooModelForm)),
    )

then create the template and load the javascipt and css required to create the editor:

    <html>
        <head>
            {{ form.media }}
        </head>
        <body>
            <form ...>
                {{ form }}
            </form>
        </body>
    </html>

#### Notes ####

* There are two widgets, `AdminPageDownWidget` and `PageDownWidget`. The only difference is that `AdminPageDownWidget` includes extra CSS to make the preview area and input pretty in the django admin. If you are using the editor for your own app, you will need to supply CSS to do this.
 
File Type Py Version Uploaded on Size
django-pagedown-0.0.5.tar.gz (md5) Source 2013-10-09 52KB
  • Downloads (All Versions):
  • 33 downloads in the last day
  • 360 downloads in the last week
  • 1361 downloads in the last month