django-markdown-utils 0.1

Installation

To get the latest stable release from PyPi

pip install django-markdown-utils

To get the latest commit from GitHub

pip install -e git+git://github.com/bitmazk/django-markdown-utils.git#egg=markdown_utils

TODO: Describe further installation steps (edit / remove the examples below):

Add markdown_utils to your INSTALLED_APPS

INSTALLED_APPS = (
    ...,
    'markdown_utils',
)

Before your tags/filters are available in your templates, load them by using

{% load markdown_utils_tags %}

Templatetags

render_markdown

Usage:

{% render_markdown some_text as markdown_text %}
{% render_markdown some_text is_safe=True as markdown_text %}
{{ markdown_text }}

Renders some given Markdown text to it’s HTML representation.

Contribute

If you want to contribute to this project, please perform the following steps

# Fork this repository
# Clone your fork
mkvirtualenv -p python2.7 django-markdown-utils
make develop

git co -b feature_branch master
# Implement your feature and tests
git add . && git commit
git push -u origin feature_branch
# Send us a pull request for your feature branch