Support Markdown in dashboard descriptions

toolness · web-flow · commit acb3752667d5 · 2021-06-06T04:07:21.000-07:00
Thanks, @toolness - closes #115
diff --git a/django_sql_dashboard/migrations/0004_add_description_help_text.py b/django_sql_dashboard/migrations/0004_add_description_help_text.py
@@ -0,0 +1,18 @@
+# Generated by Django 3.2.3 on 2021-05-25 10:58
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_sql_dashboard', '0003_update_metadata'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='dashboard',
+            name='description',
+            field=models.TextField(blank=True, help_text='Optional description (Markdown allowed)'),
+        ),
+    ]
diff --git a/django_sql_dashboard/models.py b/django_sql_dashboard/models.py
@@ -7,7 +7,9 @@
 class Dashboard(models.Model):
     slug = models.SlugField(unique=True)
     title = models.CharField(blank=True, max_length=128)
-    description = models.TextField(blank=True)
+    description = models.TextField(
+        blank=True, help_text="Optional description (Markdown allowed)"
+    )
     owned_by = models.ForeignKey(
         settings.AUTH_USER_MODEL,
         null=True,
diff --git a/django_sql_dashboard/templates/django_sql_dashboard/saved_dashboard.html b/django_sql_dashboard/templates/django_sql_dashboard/saved_dashboard.html
@@ -14,7 +14,7 @@
 {% if user_can_execute_sql %}<p><a href="{% url 'django_sql_dashboard-index' %}">Dashboard index</a></p>{% endif %}
 <h1>{% if dashboard.title %}{{ dashboard.title }}{% else %}{{ dashboard.slug }}{% endif %}</h1>
 {% if dashboard.description %}
-  <p>{{ dashboard.description }}</p>
+  {{ dashboard.description|sql_dashboard_markdown }}
 {% endif %}
 
 <p style="color: #666; font-size: 0.9em; margin-top: -1em">
diff --git a/django_sql_dashboard/views.py b/django_sql_dashboard/views.py
@@ -47,7 +47,7 @@ class Meta:
         widgets = {
             "description": Textarea(
                 attrs={
-                    "placeholder": "Optional description, shown at the top of the dashboard page"
+                    "placeholder": "Optional description, shown at the top of the dashboard page (Markdown allowed)"
                 }
             )
         }

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ class Meta:`
`47`	`47`	`widgets = {`
`48`	`48`	`"description": Textarea(`
`49`	`49`	`attrs={`
`50`		`- "placeholder": "Optional description, shown at the top of the dashboard page"`
	`50`	`+ "placeholder": "Optional description, shown at the top of the dashboard page (Markdown allowed)"`
`51`	`51`	`}`
`52`	`52`	`)`
`53`	`53`	`}`