Add markdown option for assignment descriptions (#12)

Pipfile

@@ -13,6 +13,7 @@ requests = "~=2.31"
 psutil = "~=5.9"
 celery = "~=5.3.5"  # Celery v5.4 may stop supporting Python 3.8
 django-celery-results = "~=2.5"
+django-markdownify = "~=0.9"  # includes the markdown package
 psycopg = "~=3.1"
 virtualenv = "~=20.26"
 redis = "~=5.0"

tin/apps/assignments/forms.py

@@ -28,6 +28,7 @@ class Meta:
         fields = [
             "name",
             "description",
+            "markdown",
             "folder",
             "language",
             "filename",
@@ -44,6 +45,7 @@ class Meta:
             "submission_limit_cooldown",
         ]
         labels = {
+            "markdown": "Use markdown?",
             "venv": "Virtual environment",
             "hidden": "Hide assignment from students?",
             "enable_grader_timeout": "Set a timeout for the grader?",
@@ -59,6 +61,7 @@ class Meta:
             "filename": "Clarify which file students need to upload (including the file "
             "extension). For Java assignments, this also sets the name of the "
             "saved submission file.",
+            "markdown": "This allows adding images, code blocks, or hyperlinks to the assignment description.",
             "venv": "If set, Tin will run the student's code in this virtual environment.",
             "grader_has_network_access": 'If unset, this effectively disables "Give submissions '
             'internet access" below. If set, it increases the amount '

tin/apps/assignments/migrations/0029_assignment_markdown.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.11 on 2024-05-05 00:04
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("assignments", "0028_assignment_venv"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="assignment",
+            name="markdown",
+            field=models.BooleanField(default=False),
+        ),
+    ]

tin/apps/assignments/models.py

@@ -72,6 +72,7 @@ class Assignment(models.Model):
         related_name="assignments",
     )
     description = models.CharField(max_length=4096)
+    markdown = models.BooleanField(default=False)
 
     LANGUAGES = (
         ("P", "Python 3"),

tin/settings/__init__.py

@@ -56,6 +56,7 @@
     "django_extensions",
     "django_celery_results",
     "debug_toolbar",
+    "markdownify.apps.MarkdownifyConfig",
     "tin.apps",
     "tin.apps.users",
     "tin.apps.auth",
@@ -236,6 +237,41 @@
 CELERY_BROKER_URL = "redis://localhost:6379/1"
 
 
+# Markdown
+MARKDOWNIFY = {
+    "default": {
+        "MARKDOWN_EXTENSIONS": [
+            "fenced_code",
+        ],
+        "WHITELIST_ATTRS": ["class", "href", "src", "alt"],
+        "WHITELIST_TAGS": [
+            "a",
+            "abbr",
+            "acronym",
+            "b",
+            "blockquote",
+            "code",
+            "em",
+            "h1",
+            "h2",
+            "h3",
+            "h4",
+            "h5",
+            "h6",
+            "i",
+            "img",
+            "li",
+            "ol",
+            "p",
+            "pre",
+            "span",
+            "strong",
+            "ul",
+        ],
+    }
+}
+
+
 # Django debug toolbar settings
 
 _enabled_panels = {

tin/static/css/base.css

@@ -141,7 +141,7 @@ body {
     text-align: right;
 }
 
-ul:not(.standard) {
+ul.no-list {
     list-style-type: none;
     padding-left: 0px;
 }

tin/templates/assignments/show.html

@@ -1,5 +1,6 @@
 {% extends "base.html" %}
 {% load static %}
+{% load markdownify %}
 
 {% block title %}
   Turn-In: {{ course.name }}: {% if assignment.is_quiz %}[QUIZ] {% endif %}{{ assignment.name }}
@@ -50,7 +51,11 @@ <h2 class="left">{% if assignment.is_quiz %}[QUIZ] {% endif %}{{ assignment.name
       <a class="right tin-btn" href="{% url 'assignments:submit' assignment.id %}">Submit</a>
     {% endif %}
   </div>
-  {{ assignment.description | linebreaks }}
+  {% if assignment.markdown %}
+    {{ assignment.description | markdownify }}
+  {% else %}
+    {{ assignment.description | linebreaks }}
+  {% endif %}
 
   <table id="assignment-info">
     <tr>

tin/templates/base.html

@@ -34,7 +34,7 @@
 <body>
 
 <div id="nav">
-  <ul>
+  <ul class="no-list">
     <li><a href="{% url 'auth:index' %}"><h1><span class="logo"></span>Turn-In</h1></a></li>
     {% if request.user.is_authenticated %}
       {% if course %}