Demote headings appearing in markdown

home/templatetags/markdown.py

@@ -1,12 +1,12 @@
 from django import template
 from django.template.defaultfilters import stringfilter
-from django.utils.safestring import mark_safe
+from django.utils.safestring import SafeText, mark_safe
 from markdown import markdown as markdown_func
 
 register = template.Library()
 
 
 @register.filter
 @stringfilter
-def markdown(value):
-    return mark_safe(markdown_func(value))
+def markdown(value, heading_offset=0) -> SafeText:
+    return mark_safe(markdown_func(value, extensions=['mdx_headdown'], extension_configs={'mdx_headdown': {'offset': heading_offset}}))

pyproject.toml

@@ -14,6 +14,7 @@ whitenoise = "^6.6.0"
 ministryofjustice-data-platform-catalogue = "^0.19.2"
 markdown = "^3.5.2"
 python-dotenv = "^1.0.1"
+markdown-headdown = "^0.1.3"
 
 [tool.poetry.group.dev.dependencies]
 black = "^24.2.0"

templates/details_data_product.html

@@ -27,7 +27,7 @@ <h2 class="govuk-heading-s govuk-!-margin-top-3">
           Description
       </h2>
       <div class="govuk-body">
-          {{result.description|markdown}}
+          {{result.description|markdown:3}}
       </div>
       <dl class="govuk-summary-list govuk-summary-list--no-border">
         <div class="govuk-summary-list__row">
@@ -93,9 +93,9 @@ <h2 class="govuk-heading-s govuk-!-margin-top-3">
             <th scope="row" class="govuk-table__header">{{table.name}}</th>
             <td class="govuk-table__cell">
               {% if table.description|length > 200 %}
-                {{ table.description|slice:":200"|add:"..."|markdown }}
+                {{ table.description|slice:":200"|add:"..."|markdown:3 }}
               {% else %}
-                {{ table.description|markdown }}
+                {{ table.description|markdown:3 }}
               {% endif %}
             </td>
             <td class="govuk-table__cell">  <a href="{% url 'home:details' result_type=table_type id=table.urn %}" class="govuk-link">Schema details</a></td>

templates/details_dataset.html

@@ -36,7 +36,7 @@ <h2 class="govuk-heading-s govuk-!-margin-top-3">
                 Description
             </h2>
             <p class="govuk-body">
-                {{table.description|markdown}}
+                {{table.description|markdown:3}}
             </p>
             <dl class="govuk-summary-list govuk-summary-list--no-border">
               <div class="govuk-summary-list__row">

templates/glossary.html

@@ -42,7 +42,7 @@ <h2 class="govuk-heading-l" id="{{ parent_term }}">{{ parent_term.name }}</h2>
             {% for member in parent_term.members %}
             <div data-term="{{member.name|upper}}" class="term">
                 <h3 class="govuk-heading-m" id="{{ member.name }}">{{ member.name }}</h3>
-                <p class="govuk-body">{{ member.description|markdown }}</p>
+                <p class="govuk-body">{{ member.description|markdown:3 }}</p>
             </div>
             {%endfor%}
             <br>

templates/partial/search_result.html

@@ -22,9 +22,9 @@ <h3 class="govuk-heading-m govuk-!-margin-bottom-2">
       {% if result.description %}
       <div class="govuk-body-m">
         {% if result.description|length > 200 %}
-          {{ result.description|slice:":200"|add:"..."|markdown }}
+          {{ result.description|slice:":200"|add:"..."|markdown:3 }}
         {% else %}
-          {{ result.description|markdown }}
+          {{ result.description|markdown:3 }}
         {% endif %}
       </div>
       {% endif %}