Add RSS/Atom feed

Author: joemull

config.py

@@ -50,3 +50,6 @@
     "trim_blocks": True,
     "lstrip_blocks": True,
 }
+
+# RSS settings
+rss_root_urls = ["@root/blog//"]

inc/foot.md

@@ -1,3 +1,4 @@
+- [RSS](feed.xml)
 - [ORCiD](https://orcid.org/0000-0003-3230-6090/)
 - [zirk.us](https://zirk.us/@joemull)
 - [LinkedIn](https://www.linkedin.com/in/jhmuller/)

inc/site-description.md

@@ -0,0 +1 @@
+I write about my work as a programmer and teacher and about the shenanigans that happen in academic publishing.

lib/meteor/extensions/rss.py

@@ -0,0 +1,80 @@
+import datetime
+import hashlib
+import uuid
+
+import ark
+import holly
+import os
+from feedgenerator import Atom1Feed
+from jinja2 import filters
+
+
+def get_ark_node_description(node):
+    stripped = filters.do_striptags(node.html)
+    truncated = stripped[:97].rsplit(" ", 1)[0] + "..."
+    return truncated
+
+
+def get_child_nodes(feed, node):
+    nodes = []
+    for child in node.children:
+        if child.has_children:
+            nodes.extend(get_child_nodes(feed, child))
+        elif not child.get("is_tag_base") and not child.get("is_tag_index"):
+            nodes.append(child)
+    return nodes
+
+
+def get_nodes(feed):
+    nodes = []
+    for root_url in ark.site.config.get("rss_root_urls", []):
+        node = ark.nodes.node(root_url)
+        nodes.extend(get_child_nodes(feed, node))
+        default_date = datetime.date(2000, 1, 1)
+        nodes.sort(key=lambda node: node.filepath)
+        nodes.sort(key=lambda node: node.get("date") or default_date, reverse=True)
+        nodes = nodes[:10]
+    return nodes
+
+
+@ark.events.register(ark.events.Event.EXIT_BUILD)
+def generate_feed():
+    config = ark.site.config
+    title = config.get("title", "")
+    relative_link = "feed.xml"
+    description = filters.do_striptags(
+        ark.site.includes().get("site_description", ""),
+    )
+    homepage = config.get("homepage", "")
+    if not homepage:
+        raise Exception(
+            "There must be a homepage specified in config.py to generate the RSS feed."
+        )
+    rss_link = os.path.join(homepage, relative_link)
+    feed = Atom1Feed(
+        title=title,
+        link=rss_link,
+        description=description,
+        language=config.get("lang"),
+    )
+    nodes = get_nodes(feed)
+    path = ark.site.out(relative_link)
+    for node in nodes:
+        author = node.get("author") or config.get("default_author", "")
+        node_path = ark.utils.rewrite_urls(f"'{node.url}'", path).strip("'")
+        url = os.path.join(homepage, node_path)
+        item_license = config.get("default_license", "")
+        feed.add_item(
+            title=node.get("title"),
+            author_name=author,
+            link=url,
+            description=get_ark_node_description(node),
+            pubdate=node.get("date"),
+            content=node.html,
+        )
+
+    xml = feed.writeString("utf-8")
+    if not os.path.isdir(os.path.dirname(path)):
+        os.makedirs(os.path.dirname(path))
+    with open(path, "w") as file:
+        file.write(xml)

lib/meteor/templates/node.jinja

@@ -16,6 +16,12 @@
         {{- site.title -}}
       {%- endif -%}
     </title>
+    <link
+      type="application/atom+xml"
+      rel="alternate"
+      href="@root/feed.xml"
+      title="{{ site.title }}"
+    />
     <link
       rel="preload"
       href="@root/fonts/source-sans/SourceSans3-VariableFont_wght.ttf"
@@ -44,8 +50,8 @@
 
     <link rel="icon" href="@root/images/favicon.svg" />
     <meta name="author" content="{{ node.author or site.default_author }}" />
-    {% if node.meta_description %}
-      <meta name="description" content="{{ node.meta_description.strip() }}" />
+    {% if inc.site_description %}
+      <meta name="description" content="{{ inc.site_description|striptags }}" />
     {% else %}
       <meta
         name="description"

requirements.in

@@ -1,4 +1,5 @@
 ark
+feedgenerator
 holly
 lightningcss
 marko

requirements.txt

@@ -10,6 +10,8 @@ ark==7.7.0
     # via -r requirements.in
 colorama==0.4.6
     # via ark
+feedgenerator==2.2.1
+    # via -r requirements.in
 holly==2.0.0
     # via -r requirements.in
 ibis==3.3.0

src/blog/index.md

@@ -1,4 +1,3 @@
 ---
 title: Blog
-meta_description: I write about my work as a programmer and teacher and about the shenanigans that happen in academic publishing.
 ---