Skip to content

Commit 6b403a8

Browse files
author
Jared Mackey
committed
Adding in MarkDown support. Original contributed here #127
1 parent 0f8f4b9 commit 6b403a8

File tree

3 files changed

+13
-1
lines changed

3 files changed

+13
-1
lines changed

rest_framework_docs/templates/rest_framework_docs/home.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{% extends "rest_framework_docs/docs.html" %}
2+
{% load drfdocs_filters %}
23

34
{% block apps_menu %}
45
{% regroup endpoints by name_parent as endpoints_grouped %}
@@ -56,7 +57,7 @@ <h4 class="panel-title title">
5657
<div id="{{ endpoint.path|slugify }}" class="panel-collapse collapse" role="tabpanel">
5758
<div class="panel-body">
5859
{% if endpoint.docstring %}
59-
<p class="lead">{{ endpoint.docstring }}</p>
60+
<p class="lead">{{ endpoint.docstring|markdown }}</p>
6061
{% endif %}
6162

6263
{% if endpoint.errors %}

rest_framework_docs/templatetags/__init__.py

Whitespace-only changes.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
from django import template
2+
from django.template.defaultfilters import stringfilter
3+
from rest_framework.utils.formatting import markup_description
4+
5+
register = template.Library()
6+
7+
8+
@register.filter(name='markdown')
9+
@stringfilter
10+
def markdown(value):
11+
return markup_description(value)

0 commit comments

Comments
 (0)