django-jinja-markdown 1.0

('Django-Jinja (Jinja2) extension and filter for parse markdown text markup.',)

django-jinja-markdown
==============

django-jinja (Jinja2) extension and filter for parse markdown text markup.


Requirements
============

Python-Markdown - http://packages.python.org/Markdown/


Installation
=============

Install django-jinja-markdown:

pip install django-jinja-markdown

Add 'django_jinja_markdown' to INSTALLED_APPS.

To be able to use `markdown` extension you should add it to TEMPLATES extensions list:

TEMPLATES = [
{
'BACKEND': 'django_jinja.backend.Jinja2',
'OPTIONS': {
'extensions': [
'django_jinja_markdown.extensions.MarkdownExtension',
],
}
},
]

Basic Use
=========

Example of using filter in template:

{{ content|markdown() }}

Or with additional settings:

{{ content|markdown(extensions=['nl2br',]) }}

Example of using extension:

{% markdown %}
Text which will get converted with Markdown.
{% endmarkdown %}

License
=======

This software is licensed under The MIT License (MIT). For more information, read the file LICENSE.