Django: Adding Markdown Support for Template Rendering

Two methods

• Django's django-markdown-deux module
• Python module markdown

django-markdown-deux

First, you need to install:

pip install django-markdown-deux

Modify setting.py Add markdown-deux to it

INSTALLED_APPS = [
    'markdown-deux',
]

Add tags in the template After loading the markdown-deux-tags tag, add a filter to the markdown content and it can be parsed into html.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Doc - {{ docname }}</title>
    <link href="/static/css/highlights/github.css"/>
</head>
<body>
{ % load markdown-deux-tags % }
{{ content | markdown }}
</body>
</html>

Rendering with the markdown module

First, install

pip install markdown

Use markdown rendering in views.py

import markdown

def doc(request, name):
    template = get_template('doc.html')
    docfile = get_template('doc/{}.md'.format(name))
    content = docfile.render()
    html = template.render({
        'docname': name,
        'content':
            markdown.markdown(content,
                              extensions=[
                                  'markdown.extensions.extra',
                                  'markdown.extensions.codehilite',
                                  'markdown.extensions.toc',
                              ])
    })
    return HttpResponse(html)

The markdown module will directly render markdown-formatted documents into html format. However, Django's templates will escape html, so you still need to modify the template a bit.

Modify doc.html Add the safe filter to content, indicating that escaping is not needed and the original content should be displayed directly.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Doc - {{ docname }}</title>
    <link href="/static/css/highlights/github.css"/>
</head>
<body>
{{ content | safe }}
</body>
</html>