To install django-markupmirror, use pip (or easy_install or simply python setup.py install from source) and add 'markupmirror' to the INSTALLED_APPS in your Django project.
$ pip install django-markupmirror
INSTALLED_APPS = (
...
'markupmirror',
...
)
In your settings.py specify at least MARKUPMIRROR_DEFAULT_MARKUP_TYPE which is 'plaintext' by default.
For the markup HTML-preview, you’ll need to add markupmirror’s URLs in your URLconf. In your urls.py add:
import markupmirror.urls
urlpatterns = patterns('',
(r'^markupmirror/', include(markupmirror.urls.preview)),
)
django-markupmirror depends on:
The three latter will be available automatically if the respective dependencies are met.
Use the configuration variables below in your settings.py to customize the behaviour of django-markupmirror:
Defines any of the default markup-types as default for fields where no markup_type or default_markup_type has been set explicitly.
Defaults to plaintext.
Defines the extensions to load for Markdown. Markdown’s package documentation contains a list of available extensions.
Defaults to ['extra', 'headerid(level=2)'].
Defines the output format for Markdown. One of HTML4, XHTML and HTML5.
Defaults to HTML5.
Dictionary of arguments passed directly to the Textile converter defined in textile.functions.textile.
The converter’s default function signature is: head_offset=0, html_type='xhtml', auto_link=False, encoding=None, output=None.
Defaults to:
MARKUPMIRROR_TEXTILE_SETTINGS = {
'encoding': 'utf-8',
'output': 'utf-8'
}
Basic settings passed to all CodeMirror editor instances for initialization. Check the CodeMirror documentation on configuration settings for details.
Defaults to:
MARKUPMIRROR_CODEMIRROR_SETTINGS = {
'width': '50%',
'height': '300px',
'indentUnit': 4,
'lineNumbers': True,
'lineWrapping': True,
'path': settings.STATIC_URL + 'markupmirror/',
}