From f7029012dfb73ce04405bfe44e4e4d984818bf5f Mon Sep 17 00:00:00 2001
From: Ben Schlegel <ben5.schlegel@gmail.com>
Date: Sat, 16 Sep 2023 19:58:38 +0000
Subject: [PATCH] feat: black magic
---
quartz/plugins/emitters/contentIndex.ts | 102 +++++++++++++++++++++++++++++++--------------------
1 files changed, 62 insertions(+), 40 deletions(-)
diff --git a/quartz/plugins/emitters/contentIndex.ts b/quartz/plugins/emitters/contentIndex.ts
index a94b552..911173e 100644
--- a/quartz/plugins/emitters/contentIndex.ts
+++ b/quartz/plugins/emitters/contentIndex.ts
@@ -1,14 +1,19 @@
+import { Root } from "hast"
import { GlobalConfiguration } from "../../cfg"
-import { CanonicalSlug, ClientSlug, FilePath, ServerSlug, canonicalizeServer } from "../../path"
+import { getDate } from "../../components/Date"
+import { escapeHTML } from "../../util/escape"
+import { FilePath, FullSlug, SimpleSlug, simplifySlug } from "../../util/path"
import { QuartzEmitterPlugin } from "../types"
+import { toHtml } from "hast-util-to-html"
import path from "path"
-export type ContentIndex = Map<CanonicalSlug, ContentDetails>
+export type ContentIndex = Map<FullSlug, ContentDetails>
export type ContentDetails = {
title: string
- links: CanonicalSlug[]
+ links: SimpleSlug[]
tags: string[]
content: string
+ richContent?: string
date?: Date
description?: string
}
@@ -16,51 +21,59 @@
interface Options {
enableSiteMap: boolean
enableRSS: boolean
+ rssLimit?: number
+ rssFullHtml: boolean
includeEmptyFiles: boolean
}
const defaultOptions: Options = {
enableSiteMap: true,
enableRSS: true,
- includeEmptyFiles: false,
+ rssLimit: 10,
+ rssFullHtml: false,
+ includeEmptyFiles: true,
}
function generateSiteMap(cfg: GlobalConfiguration, idx: ContentIndex): string {
const base = cfg.baseUrl ?? ""
- const createURLEntry = (slug: CanonicalSlug, content: ContentDetails): string => `<url>
- <loc>https://${base}/${slug}</loc>
+ 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(slug, content))
+ .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 {
+function generateRSSFeed(cfg: GlobalConfiguration, idx: ContentIndex, limit?: number): string {
const base = cfg.baseUrl ?? ""
- const root = `https://${base}` as ClientSlug
+ const root = `https://${base}`
- const createURLEntry = (slug: CanonicalSlug, content: ContentDetails): string => `<items>
- <title>${content.title}</title>
- <link>${root}/${slug}</link>
- <guid>${root}/${slug}</guid>
- <description>${content.description}</description>
+ 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.richContent ?? content.description}</description>
<pubDate>${content.date?.toUTCString()}</pubDate>
- </items>`
+ </item>`
const items = Array.from(idx)
- .map(([slug, content]) => createURLEntry(slug, content))
+ .map(([slug, content]) => createURLEntry(simplifySlug(slug), content))
+ .slice(0, limit ?? idx.size)
.join("")
- return `<rss xmlns:atom="http://www.w3.org/2005/atom" version="2.0">
+
+ return `<?xml version="1.0" encoding="UTF-8" ?>
+<rss version="2.0">
<channel>
- <title>${cfg.pageTitle}</title>
+ <title>${escapeHTML(cfg.pageTitle)}</title>
<link>${root}</link>
- <description>Recent content on ${cfg.pageTitle}</description>
+ <description>${!!limit ? `Last ${limit} notes` : "Recent notes"} on ${
+ cfg.pageTitle
+ }</description>
<generator>Quartz -- quartz.jzhao.xyz</generator>
- <atom:link href="${root}/index.xml" rel="self" type="application/rss+xml"/>
+ ${items}
</channel>
- ${items}
</rss>`
}
@@ -72,15 +85,18 @@
const cfg = ctx.cfg.configuration
const emitted: FilePath[] = []
const linkIndex: ContentIndex = new Map()
- for (const [_tree, file] of content) {
- const slug = canonicalizeServer(file.data.slug!)
- const date = file.data.dates?.modified ?? new Date()
+ for (const [tree, file] of content) {
+ 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 ?? "",
+ richContent: opts?.rssFullHtml
+ ? escapeHTML(toHtml(tree as Root, { allowDangerousHtml: true }))
+ : undefined,
date: date,
description: file.data.description ?? "",
})
@@ -88,22 +104,26 @@
}
if (opts?.enableSiteMap) {
- emitted.push(await emit({
- content: generateSiteMap(cfg, linkIndex),
- slug: "sitemap" as ServerSlug,
- ext: ".xml",
- }))
+ emitted.push(
+ await emit({
+ content: generateSiteMap(cfg, linkIndex),
+ slug: "sitemap" as FullSlug,
+ ext: ".xml",
+ }),
+ )
}
if (opts?.enableRSS) {
- emitted.push(await emit({
- content: generateRSSFeed(cfg, linkIndex),
- slug: "index" as ServerSlug,
- ext: ".xml",
- }))
+ emitted.push(
+ await emit({
+ content: generateRSSFeed(cfg, linkIndex, opts.rssLimit),
+ slug: "index" as FullSlug,
+ ext: ".xml",
+ }),
+ )
}
- const fp = path.join("static", "contentIndex") as ServerSlug
+ 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
@@ -115,11 +135,13 @@
}),
)
- emitted.push(await emit({
- content: JSON.stringify(simplifiedIndex),
- slug: fp,
- ext: ".json",
- }))
+ emitted.push(
+ await emit({
+ content: JSON.stringify(simplifiedIndex),
+ slug: fp,
+ ext: ".json",
+ }),
+ )
return emitted
},
--
Gitblit v1.10.0