whitelist rss feed

Author: float3

quartz-local/content-index-filtered/index.ts

@@ -0,0 +1,241 @@
+import path from "path"
+import fs from "fs/promises"
+import type { GlobalConfiguration } from "../../quartz/cfg"
+import type { BuildCtx } from "../../quartz/util/ctx"
+import type { QuartzEmitterPlugin } from "../../quartz/plugins/types"
+import type { ProcessedContent, QuartzPluginData } from "../../quartz/plugins/vfile"
+import { escapeHTML } from "../../quartz/util/escape"
+import {
+  type FilePath,
+  type FullSlug,
+  type SimpleSlug,
+  joinSegments,
+  simplifySlug,
+} from "../../quartz/util/path"
+
+export type ContentIndexMap = Map<FullSlug, ContentDetails>
+
+export type ContentDetails = {
+  slug: FullSlug
+  filePath: FilePath
+  title: string
+  links: SimpleSlug[]
+  tags: string[]
+  content: string
+  richContent?: string
+  date?: Date
+  description?: string
+}
+
+type Options = {
+  enableSiteMap: boolean
+  enableRSS: boolean
+  rssLimit?: number
+  rssFullHtml: boolean
+  rssSlug: string
+  includeEmptyFiles: boolean
+  rssIncludePrefixes: string[]
+  rssRecentNotesText?: string
+  rssLastFewNotesText?: (count: number) => string
+}
+
+const defaultOptions: Options = {
+  enableSiteMap: true,
+  enableRSS: true,
+  rssLimit: 10,
+  rssFullHtml: false,
+  rssSlug: "index",
+  includeEmptyFiles: true,
+  rssIncludePrefixes: [],
+  rssRecentNotesText: "Recent notes",
+  rssLastFewNotesText: (count) => `Last ${count} notes`,
+}
+
+const write = async (args: {
+  ctx: BuildCtx
+  content: string
+  slug: FullSlug
+  ext: string
+}): Promise<FilePath> => {
+  const pathToPage = joinSegments(args.ctx.argv.output, args.slug + args.ext) as FilePath
+  const dir = path.dirname(pathToPage)
+  await fs.mkdir(dir, { recursive: true })
+  await fs.writeFile(pathToPage, args.content)
+  return pathToPage
+}
+
+function dateFor(data: QuartzPluginData): Date | undefined {
+  const dateType = data.defaultDateType as keyof NonNullable<QuartzPluginData["dates"]> | undefined
+  const value =
+    (dateType ? data.dates?.[dateType] : undefined) ??
+    data.dates?.modified ??
+    data.dates?.created ??
+    data.dates?.published
+
+  if (!value) return undefined
+  const date = value instanceof Date ? value : new Date(value)
+  return Number.isNaN(date.valueOf()) ? undefined : date
+}
+
+function normalizePrefix(prefix: string): string {
+  return prefix.replace(/^\/+/, "").replace(/\/?$/, "/")
+}
+
+function rssIndex(idx: ContentIndexMap, rssIncludePrefixes: string[]): ContentIndexMap {
+  const prefixes = rssIncludePrefixes.map(normalizePrefix).filter((prefix) => prefix.length > 1)
+  if (prefixes.length === 0) return idx
+
+  return new Map(
+    Array.from(idx).filter(([slug]) => {
+      const normalized = simplifySlug(slug)
+      return prefixes.some((prefix) => normalized.startsWith(prefix) && normalized !== prefix)
+    }),
+  )
+}
+
+function generateSiteMap(cfg: GlobalConfiguration, idx: ContentIndexMap): string {
+  const base = cfg.baseUrl ?? ""
+  const createURLEntry = (slug: SimpleSlug, content: ContentDetails): string => `<url>
+    <loc>https://${joinSegments(base, encodeURI(slug))}</loc>
+    ${content.date && `<lastmod>${content.date.toISOString()}</lastmod>`}
+  </url>`
+  const urls = Array.from(idx)
+    .map(([slug, content]) => createURLEntry(simplifySlug(slug) as SimpleSlug, 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: ContentIndexMap,
+  options: Options,
+  limit?: number,
+): string {
+  const base = cfg.baseUrl ?? ""
+  const pageTitle = cfg.pageTitle ?? ""
+  const recentNotesText = options.rssRecentNotesText ?? "Recent notes"
+  const lastFewNotesText =
+    options.rssLastFewNotesText ?? ((count: number) => `Last ${count} notes`)
+
+  const createURLEntry = (slug: SimpleSlug, content: ContentDetails): string => `<item>
+    <title>${escapeHTML(content.title)}</title>
+    <link>https://${joinSegments(base, encodeURI(slug))}</link>
+    <guid>https://${joinSegments(base, encodeURI(slug))}</guid>
+    <description><![CDATA[ ${content.richContent ?? content.description} ]]></description>
+    <pubDate>${content.date?.toUTCString()}</pubDate>
+  </item>`
+
+  const items = Array.from(idx)
+    .sort(([_, f1], [__, f2]) => {
+      if (f1.date && f2.date) return f2.date.getTime() - f1.date.getTime()
+      if (f1.date && !f2.date) return -1
+      if (!f1.date && f2.date) return 1
+      return f1.title.localeCompare(f2.title)
+    })
+    .map(([slug, content]) => createURLEntry(simplifySlug(slug) as SimpleSlug, content))
+    .slice(0, limit ?? idx.size)
+    .join("")
+
+  const description = `${
+    limit ? lastFewNotesText(limit) : recentNotesText
+  } on ${escapeHTML(pageTitle)}`
+
+  return `<?xml version="1.0" encoding="UTF-8" ?>
+<rss version="2.0">
+    <channel>
+      <title>${escapeHTML(pageTitle)}</title>
+      <link>https://${base}</link>
+      <description>${description}</description>
+      <generator>Quartz -- quartz.jzhao.xyz</generator>
+      ${items}
+    </channel>
+  </rss>`
+}
+
+export const ContentIndexFiltered: QuartzEmitterPlugin<Partial<Options>> = (opts) => {
+  const options = { ...defaultOptions, ...opts }
+  const emitAll = async (ctx: BuildCtx, content: ProcessedContent[]): Promise<FilePath[]> => {
+    const cfg = ctx.cfg.configuration
+    const linkIndex: ContentIndexMap = new Map()
+    for (const [, file] of content) {
+      const data = (file.data as QuartzPluginData & Record<string, unknown>) ?? {}
+      if (data.unlisted === true) continue
+
+      const slug = data.slug as FullSlug
+      const date = dateFor(data) ?? new Date()
+      const text = data.text as string | undefined
+      if (options.includeEmptyFiles || (text && text !== "")) {
+        const frontmatter = (data.frontmatter as Record<string, unknown> | undefined) ?? {}
+        const isEncrypted = data.encrypted === true
+        linkIndex.set(slug, {
+          slug,
+          filePath: data.relativePath as FilePath,
+          title: (frontmatter.title as string) ?? "",
+          links: (data.links as SimpleSlug[] | undefined) ?? [],
+          tags: (frontmatter.tags as string[] | undefined) ?? [],
+          content: text ?? "",
+          richContent:
+            options.rssFullHtml && !isEncrypted && text ? escapeHTML(text) : undefined,
+          date,
+          description: (data.description as string | undefined) ?? "",
+        })
+      }
+    }
+
+    const outputs: FilePath[] = []
+    if (options.enableSiteMap) {
+      outputs.push(
+        await write({
+          ctx,
+          content: generateSiteMap(cfg, linkIndex),
+          slug: "sitemap" as FullSlug,
+          ext: ".xml",
+        }),
+      )
+    }
+
+    if (options.enableRSS) {
+      outputs.push(
+        await write({
+          ctx,
+          content: generateRSSFeed(
+            cfg,
+            rssIndex(linkIndex, options.rssIncludePrefixes),
+            options,
+            options.rssLimit,
+          ),
+          slug: (options.rssSlug ?? "index") as FullSlug,
+          ext: ".xml",
+        }),
+      )
+    }
+
+    const fp = joinSegments("static", "contentIndex") as FullSlug
+    const simplifiedIndex = Object.fromEntries(
+      Array.from(linkIndex).map(([slug, content]) => {
+        delete content.description
+        delete content.date
+        return [slug, content]
+      }),
+    )
+
+    outputs.push(
+      await write({
+        ctx,
+        content: JSON.stringify(simplifiedIndex),
+        slug: fp,
+        ext: ".json",
+      }),
+    )
+
+    return outputs
+  }
+
+  return {
+    name: "ContentIndexFiltered",
+    emit: (ctx, content) => emitAll(ctx, content),
+    partialEmit: (ctx, content) => emitAll(ctx, content),
+  }
+}
+
+export default ContentIndexFiltered

quartz-local/content-index-filtered/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@hill/quartz-content-index-filtered",
+  "version": "1.0.0",
+  "type": "module",
+  "exports": {
+    ".": "./index.ts"
+  },
+  "quartz": {
+    "name": "content-index-filtered",
+    "displayName": "Filtered Content Index",
+    "description": "Generate the sitemap, RSS feed, and content index with optional RSS path filtering.",
+    "version": "1.0.0",
+    "category": "emitter",
+    "defaultOrder": 50
+  }
+}

quartz.config.yaml

@@ -115,11 +115,15 @@ plugins:
     enabled: true
   - source: github:quartz-community/alias-redirects
     enabled: true
-  - source: github:quartz-community/content-index
+  - source: ./quartz-local/content-index-filtered
     enabled: true
     options:
       enableSiteMap: true
       enableRSS: true
+      rssIncludePrefixes:
+        - blog/
+        - notes/
+        - tools/
   - source: github:quartz-community/favicon
     enabled: true
   - source: github:quartz-community/og-image