quartz-research-note/quartz/plugins/emitters/contentIndex.ts

141 lines
4.1 KiB
TypeScript
Raw Normal View History

2023-07-01 20:35:27 +00:00
import { GlobalConfiguration } from "../../cfg"
import {
CanonicalSlug,
ClientSlug,
FilePath,
ServerSlug,
canonicalizeServer,
} from "../../util/path"
2023-06-17 02:41:59 +00:00
import { QuartzEmitterPlugin } from "../types"
import path from "path"
2023-07-13 07:19:35 +00:00
export type ContentIndex = Map<CanonicalSlug, ContentDetails>
2023-06-18 17:47:07 +00:00
export type ContentDetails = {
2023-07-23 00:27:41 +00:00
title: string
links: CanonicalSlug[]
tags: string[]
content: string
date?: Date
description?: string
2023-06-18 17:47:07 +00:00
}
2023-06-17 02:41:59 +00:00
2023-07-01 20:35:27 +00:00
interface Options {
enableSiteMap: boolean
enableRSS: boolean
includeEmptyFiles: boolean
2023-07-01 20:35:27 +00:00
}
const defaultOptions: Options = {
enableSiteMap: true,
enableRSS: true,
includeEmptyFiles: false,
2023-07-01 20:35:27 +00:00
}
function generateSiteMap(cfg: GlobalConfiguration, idx: ContentIndex): string {
2023-07-13 07:19:35 +00:00
const base = cfg.baseUrl ?? ""
const createURLEntry = (slug: CanonicalSlug, content: ContentDetails): string => `<url>
2023-07-01 20:35:27 +00:00
<loc>https://${base}/${slug}</loc>
<lastmod>${content.date?.toISOString()}</lastmod>
</url>`
2023-07-23 00:27:41 +00:00
const urls = Array.from(idx)
.map(([slug, content]) => createURLEntry(slug, content))
.join("")
2023-07-01 20:35:27 +00:00
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 {
2023-07-13 07:19:35 +00:00
const base = cfg.baseUrl ?? ""
const root = `https://${base}` as ClientSlug
2023-07-01 20:35:27 +00:00
2023-07-13 07:19:35 +00:00
const createURLEntry = (slug: CanonicalSlug, content: ContentDetails): string => `<items>
2023-07-01 20:35:27 +00:00
<title>${content.title}</title>
<link>${root}/${slug}</link>
<guid>${root}/${slug}</guid>
<description>${content.description}</description>
<pubDate>${content.date?.toUTCString()}</pubDate>
</items>`
2023-07-23 00:27:41 +00:00
const items = Array.from(idx)
.map(([slug, content]) => createURLEntry(slug, content))
.join("")
2023-07-01 20:35:27 +00:00
return `<rss xmlns:atom="http://www.w3.org/2005/atom" version="2.0">
<channel>
<title>${cfg.pageTitle}</title>
<link>${root}</link>
<description>Recent content on ${cfg.pageTitle}</description>
<generator>Quartz -- quartz.jzhao.xyz</generator>
<atom:link href="${root}/index.xml" rel="self" type="application/rss+xml"/>
</channel>
${items}
</rss>`
}
export const ContentIndex: QuartzEmitterPlugin<Partial<Options>> = (opts) => {
2023-07-01 20:35:27 +00:00
opts = { ...defaultOptions, ...opts }
2023-06-17 02:41:59 +00:00
return {
name: "ContentIndex",
async emit(ctx, content, _resources, emit) {
const cfg = ctx.cfg.configuration
const emitted: FilePath[] = []
2023-06-17 02:41:59 +00:00
const linkIndex: ContentIndex = new Map()
2023-06-20 03:37:45 +00:00
for (const [_tree, file] of content) {
const slug = canonicalizeServer(file.data.slug!)
2023-07-01 20:35:27 +00:00
const date = file.data.dates?.modified ?? new Date()
if (opts?.includeEmptyFiles || (file.data.text && file.data.text !== "")) {
2023-07-23 00:27:41 +00:00
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 ?? "",
})
}
2023-06-17 02:41:59 +00:00
}
2023-07-01 20:35:27 +00:00
if (opts?.enableSiteMap) {
2023-08-11 04:29:11 +00:00
emitted.push(
await emit({
content: generateSiteMap(cfg, linkIndex),
slug: "sitemap" as ServerSlug,
ext: ".xml",
}),
)
2023-07-01 20:35:27 +00:00
}
if (opts?.enableRSS) {
2023-08-11 04:29:11 +00:00
emitted.push(
await emit({
content: generateRSSFeed(cfg, linkIndex),
slug: "index" as ServerSlug,
ext: ".xml",
}),
)
2023-07-01 20:35:27 +00:00
}
const fp = path.join("static", "contentIndex") as ServerSlug
2023-07-01 20:35:27 +00:00
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]
2023-07-23 00:27:41 +00:00
}),
2023-07-01 20:35:27 +00:00
)
2023-08-11 04:29:11 +00:00
emitted.push(
await emit({
content: JSON.stringify(simplifiedIndex),
slug: fp,
ext: ".json",
}),
)
2023-06-17 02:41:59 +00:00
2023-07-01 20:35:27 +00:00
return emitted
2023-06-17 02:41:59 +00:00
},
getQuartzComponents: () => [],
}
}