Fixed #1675 -- Added support for authoring markdown blog entries

Author: bmispelon

blog/admin.py

@@ -1,4 +1,5 @@
 from django.contrib import admin
+from django.utils.translation import gettext as _
 
 from .models import Entry, Event
 
@@ -12,6 +13,8 @@ class EntryAdmin(admin.ModelAdmin):
 
     def formfield_for_dbfield(self, db_field, **kwargs):
         formfield = super().formfield_for_dbfield(db_field, **kwargs)
+        if db_field.name == "content_format":
+            formfield.help_text = _("Psst, we have markdown now 🤫")
         if db_field.name == "body":
             formfield.widget.attrs.update(
                 {

blog/migrations/0003_entry_content_format_markdown.py

@@ -0,0 +1,25 @@
+# Generated by Django 4.2.14 on 2024-10-17 15:08
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("blog", "0002_event"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="entry",
+            name="content_format",
+            field=models.CharField(
+                choices=[
+                    ("reST", "reStructuredText"),
+                    ("html", "Raw HTML"),
+                    ("md", "Markdown"),
+                ],
+                max_length=50,
+            ),
+        ),
+    ]

blog/models.py

@@ -9,6 +9,8 @@
 from django.utils.translation import gettext_lazy as _
 from django_hosts.resolvers import reverse
 from docutils.core import publish_parts
+from markdown import markdown
+from markdown.extensions.toc import TocExtension, slugify as _md_title_slugify
 
 BLOG_DOCUTILS_SETTINGS = {
     "doctitle_xform": False,
@@ -20,6 +22,11 @@
 BLOG_DOCUTILS_SETTINGS.update(getattr(settings, "BLOG_DOCUTILS_SETTINGS", {}))
 
 
+def _md_slugify(value, separator):
+    # matches the `id_prefix` setting of BLOG_DOCUTILS_SETTINGS
+    return "s" + separator + _md_title_slugify(value, separator)
+
+
 class EntryQuerySet(models.QuerySet):
     def published(self):
         return self.active().filter(pub_date__lte=timezone.now())
@@ -31,6 +38,7 @@ def active(self):
 class ContentFormat(models.TextChoices):
     REST = "reST", "reStructuredText"
     HTML = "html", "Raw HTML"
+    MARKDOWN = "md", "Markdown"
 
     @classmethod
     def to_html(cls, fmt, source):
@@ -45,6 +53,15 @@ def to_html(cls, fmt, source):
                 writer_name="html",
                 settings_overrides=BLOG_DOCUTILS_SETTINGS,
             )["fragment"]
+        if fmt == cls.MARKDOWN:
+            return markdown(
+                source,
+                output_format="html",
+                extensions=[
+                    # baselevel matches `initial_header_level` from BLOG_DOCUTILS_SETTINGS
+                    TocExtension(baselevel=3, slugify=_md_slugify),
+                ],
+            )
         raise ValueError(f"Unsupported format {fmt}")
 
 

blog/tests.py

@@ -94,6 +94,35 @@ def test_content_format_reST(self):
         )
         self.assertHTMLEqual(entry.body_html, "<p><strong>test</strong></p>")
 
+    def test_content_format_markdown(self):
+        entry = Entry.objects.create(
+            pub_date=self.now,
+            slug="a",
+            body="**test**",
+            content_format=ContentFormat.MARKDOWN,
+        )
+        self.assertHTMLEqual(entry.body_html, "<p><strong>test</strong></p>")
+
+    def test_header_base_level_reST(self):
+        entry = Entry.objects.create(
+            pub_date=self.now,
+            slug="a",
+            body="test\n====",
+            content_format=ContentFormat.REST,
+        )
+        self.assertHTMLEqual(
+            entry.body_html, '<div class="section" id="s-test"><h3>test</h3></div>'
+        )
+
+    def test_header_base_level_markdown(self):
+        entry = Entry.objects.create(
+            pub_date=self.now,
+            slug="a",
+            body="# test",
+            content_format=ContentFormat.MARKDOWN,
+        )
+        self.assertHTMLEqual(entry.body_html, '<h3 id="s-test">test</h3>')
+
 
 class EventTestCase(DateTimeMixin, TestCase):
     def test_manager_past_future(self):

requirements/common.txt

@@ -12,6 +12,7 @@ docutils==0.20.1
 feedparser==6.0.11
 Jinja2==3.1.4
 libsass==0.23.0
+Markdown==3.7
 Pillow==10.4.0
 psycopg2==2.9.10
 Pygments==2.18.0