Skip to main content

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

Project description

Django Pagedown

A django app that allows the easy addition of [Stack Overflow's "Pagedown" Markdown editor]( to a django form field, whether in a custom app or the Django Admin


![Screenshot of Django Admin with Pagedown initialised]( "A screenshot of Pagedown in Django's admin")


#### Installation ####

1. Get the code: `pip install django-pagedown`
2. Add `pagedown` to your `INSTALLED_APPS`

Note that this package will install a cloned copy (git submodule)of the Pagedown library from [](

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

- Via pip from GitHub: `pip install -e`
- Manually clone from Github:
- `git clone`
- `cd django-pagedown`
- `git submodule update --init`

#### Usage ####

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 ``):

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

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

class FooModelAdmin(admin.ModelAdmin):
form = FooModelForm, FooModelAdmin)

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

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-pagedown-0.0.4.tar.gz (52.4 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