django-codemirror2 0.1.1

Django widgets for replacing textareas with CodeMirror2, an in-browser code editor

Django widgets for replacing textareas with CodeMirror2, an in-browser code editor.

Installing

1. pip install django-codemirror2

2. Add codemirror2 to INSTALLED_APPS

3. Collect static files: python manage.py collectstatic

If you just want to see it in action, see the almost-ready-to-run project in examples.

Usage

from django import forms
from codemirror2.widgets import CodeMirrorEditor

class TestForm(forms.Form):
    css = forms.Charfield(widget=CodeMirrorEditor(options={'mode': 'css'}))

The options argument will be passed as JSON to CodeMirror.fromTextArea, see http://codemirror.net/manual.html#config for possible values. If you want to use a mode that depends on other modes, for example htmlmixed, you need to load the dependencies, too, by passing the modes parameter:

html = forms.Charfield(widget=CodeMirrorEditor(modes=['css', 'xml', 'javascript', 'htmlmixed'],
            options={'mode': 'htmlmixed'}))

If you want to customize the Javascript used to initialize the CodeMirror editor, use script_template:

foo = forms.Charfield(widget=CodeMirrorEditor(options={'mode': 'xml'},
            script_template='some/template.html'))