base path refactor, more docs

Jacky Zhao

2023-07-13 906f91f8eed5e91a7afae95c7002a3e4553d6aae

 quartz/plugins/emitters/contentIndex.ts

@@ -1,11 +1,12 @@
import { GlobalConfiguration } from "../../cfg"
import { CanonicalSlug, ClientSlug } from "../../path"
import { QuartzEmitterPlugin } from "../types"
import path from "path"

export type ContentIndex = Map<string, ContentDetails>
export type ContentIndex = Map<CanonicalSlug, ContentDetails>
export type ContentDetails = {
  title: string,
  links: string[],
  links: CanonicalSlug[],
  tags: string[],
  content: string,
  date?: Date,
@@ -15,16 +16,18 @@
interface Options {
  enableSiteMap: boolean
  enableRSS: boolean
  includeEmptyFiles: boolean
}

const defaultOptions: Options = {
  enableSiteMap: true,
  enableRSS: true,
  includeEmptyFiles: false,
}

function generateSiteMap(cfg: GlobalConfiguration, idx: ContentIndex): string {
  const base = cfg.canonicalUrl ?? ""
  const createURLEntry = (slug: string, content: ContentDetails): string => `<url>
  const base = cfg.baseUrl ?? ""
  const createURLEntry = (slug: CanonicalSlug, content: ContentDetails): string => `<url>
    <loc>https://${base}/${slug}</loc>
    <lastmod>${content.date?.toISOString()}</lastmod>
  </url>`
@@ -33,11 +36,10 @@
}

function generateRSSFeed(cfg: GlobalConfiguration, idx: ContentIndex): string {
  const base = cfg.canonicalUrl ?? ""
  const root = `https://${base}`
  const base = cfg.baseUrl ?? ""
  const root = `https://${base}` as ClientSlug

  // TODO: ogimage
  const createURLEntry = (slug: string, content: ContentDetails): string => `<items>
  const createURLEntry = (slug: CanonicalSlug, content: ContentDetails): string => `<items>
    <title>${content.title}</title>
    <link>${root}/${slug}</link>
    <guid>${root}/${slug}</guid>
@@ -58,7 +60,7 @@
  </rss>`
}

export const ContentIndex: QuartzEmitterPlugin<Options> = (opts) => {
export const ContentIndex: QuartzEmitterPlugin<Partial<Options>> = (opts) => {
  opts = { ...defaultOptions, ...opts }
  return {
    name: "ContentIndex",
@@ -68,6 +70,7 @@
      for (const [_tree, file] of content) {
        const slug = file.data.slug!
        const date = file.data.dates?.modified ?? new Date()
        if (opts?.includeEmptyFiles || (file.data.text && file.data.text !== "")) {
        linkIndex.set(slug, {
          title: file.data.frontmatter?.title!,
          links: file.data.links ?? [],
@@ -76,6 +79,7 @@
          date: date,
          description: file.data.description ?? ""
        })
        }
      }

      if (opts?.enableSiteMap) {
@@ -107,6 +111,7 @@
          return [slug, content]
        })
      )

      await emit({
        content: JSON.stringify(simplifiedIndex),
        slug: fp,