From 2525bfbab5553f970997ea3c60af180cbef1fdd2 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Thu, 07 Sep 2023 05:24:15 +0000
Subject: [PATCH] fix: links to index not showing in graph (closes #450)

---
 quartz/plugins/emitters/contentIndex.ts |  140 +++++++++++++++++++++++++++++++++++++++-------
 1 files changed, 119 insertions(+), 21 deletions(-)

diff --git a/quartz/plugins/emitters/contentIndex.ts b/quartz/plugins/emitters/contentIndex.ts
index cd7c924..f24ae6d 100644
--- a/quartz/plugins/emitters/contentIndex.ts
+++ b/quartz/plugins/emitters/contentIndex.ts
@@ -1,37 +1,135 @@
+import { GlobalConfiguration } from "../../cfg"
+import { getDate } from "../../components/Date"
+import { escapeHTML } from "../../util/escape"
+import { FilePath, FullSlug, SimpleSlug, simplifySlug } from "../../util/path"
 import { QuartzEmitterPlugin } from "../types"
 import path from "path"
 
-export type ContentIndex = Map<string, ContentDetails>
+export type ContentIndex = Map<FullSlug, ContentDetails>
 export type ContentDetails = {
-  title: string,
-  links?: string[],
-  tags?: string[],
-  content: string,
+  title: string
+  links: SimpleSlug[]
+  tags: string[]
+  content: string
+  date?: Date
+  description?: string
 }
 
-export const ContentIndex: QuartzEmitterPlugin = () => {
+interface Options {
+  enableSiteMap: boolean
+  enableRSS: boolean
+  includeEmptyFiles: boolean
+}
+
+const defaultOptions: Options = {
+  enableSiteMap: true,
+  enableRSS: true,
+  includeEmptyFiles: true,
+}
+
+function generateSiteMap(cfg: GlobalConfiguration, idx: ContentIndex): string {
+  const base = cfg.baseUrl ?? ""
+  const createURLEntry = (slug: SimpleSlug, content: ContentDetails): string => `<url>
+    <loc>https://${base}/${encodeURI(slug)}</loc>
+    <lastmod>${content.date?.toISOString()}</lastmod>
+  </url>`
+  const urls = Array.from(idx)
+    .map(([slug, content]) => createURLEntry(simplifySlug(slug), content))
+    .join("")
+  return `<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml">${urls}</urlset>`
+}
+
+function generateRSSFeed(cfg: GlobalConfiguration, idx: ContentIndex): string {
+  const base = cfg.baseUrl ?? ""
+  const root = `https://${base}`
+
+  const createURLEntry = (slug: SimpleSlug, content: ContentDetails): string => `<item>
+    <title>${escapeHTML(content.title)}</title>
+    <link>${root}/${encodeURI(slug)}</link>
+    <guid>${root}/${encodeURI(slug)}</guid>
+    <description>${content.description}</description>
+    <pubDate>${content.date?.toUTCString()}</pubDate>
+  </item>`
+
+  const items = Array.from(idx)
+    .map(([slug, content]) => createURLEntry(simplifySlug(slug), content))
+    .join("")
+  return `<?xml version="1.0" encoding="UTF-8" ?>
+<rss version="2.0">
+    <channel>
+      <title>${escapeHTML(cfg.pageTitle)}</title>
+      <link>${root}</link>
+      <description>Recent content on ${cfg.pageTitle}</description>
+      <generator>Quartz -- quartz.jzhao.xyz</generator>
+      ${items}
+    </channel>
+  </rss>`
+}
+
+export const ContentIndex: QuartzEmitterPlugin<Partial<Options>> = (opts) => {
+  opts = { ...defaultOptions, ...opts }
   return {
     name: "ContentIndex",
-    async emit(_contentDir, _cfg, content, _resources, emit) {
-      const fp = path.join("static", "contentIndex")
+    async emit(ctx, content, _resources, emit) {
+      const cfg = ctx.cfg.configuration
+      const emitted: FilePath[] = []
       const linkIndex: ContentIndex = new Map()
       for (const [_tree, file] of content) {
-        let slug = file.data.slug!
-        linkIndex.set(slug, {
-          title: file.data.frontmatter?.title!,
-          links: file.data.links ?? [],
-          tags: file.data.frontmatter?.tags,
-          content: file.data.text ?? ""
-        })
+        const slug = file.data.slug!
+        const date = getDate(ctx.cfg.configuration, file.data) ?? new Date()
+        if (opts?.includeEmptyFiles || (file.data.text && file.data.text !== "")) {
+          linkIndex.set(slug, {
+            title: file.data.frontmatter?.title!,
+            links: file.data.links ?? [],
+            tags: file.data.frontmatter?.tags ?? [],
+            content: file.data.text ?? "",
+            date: date,
+            description: file.data.description ?? "",
+          })
+        }
       }
 
-      await emit({
-        content: JSON.stringify(Object.fromEntries(linkIndex)),
-        slug: fp,
-        ext: ".json",
-      })
+      if (opts?.enableSiteMap) {
+        emitted.push(
+          await emit({
+            content: generateSiteMap(cfg, linkIndex),
+            slug: "sitemap" as FullSlug,
+            ext: ".xml",
+          }),
+        )
+      }
 
-      return [`${fp}.json`]
+      if (opts?.enableRSS) {
+        emitted.push(
+          await emit({
+            content: generateRSSFeed(cfg, linkIndex),
+            slug: "index" as FullSlug,
+            ext: ".xml",
+          }),
+        )
+      }
+
+      const fp = path.join("static", "contentIndex") as FullSlug
+      const simplifiedIndex = Object.fromEntries(
+        Array.from(linkIndex).map(([slug, content]) => {
+          // remove description and from content index as nothing downstream
+          // actually uses it. we only keep it in the index as we need it
+          // for the RSS feed
+          delete content.description
+          delete content.date
+          return [slug, content]
+        }),
+      )
+
+      emitted.push(
+        await emit({
+          content: JSON.stringify(simplifiedIndex),
+          slug: fp,
+          ext: ".json",
+        }),
+      )
+
+      return emitted
     },
     getQuartzComponents: () => [],
   }

--
Gitblit v1.10.0