From c538c151c7462ad0395ff2c15c5e11e89e362aa8 Mon Sep 17 00:00:00 2001
From: Striven <sg.striven@cutecat.club>
Date: Sat, 04 Apr 2026 19:47:16 +0000
Subject: [PATCH] Initial commit
---
quartz/plugins/emitters/contentPage.tsx | 134 +++++++++++++++++++++++++++++++++-----------
1 files changed, 99 insertions(+), 35 deletions(-)
diff --git a/quartz/plugins/emitters/contentPage.tsx b/quartz/plugins/emitters/contentPage.tsx
index 889cf60..c3410ec 100644
--- a/quartz/plugins/emitters/contentPage.tsx
+++ b/quartz/plugins/emitters/contentPage.tsx
@@ -1,57 +1,121 @@
+import path from "path"
import { QuartzEmitterPlugin } from "../types"
import { QuartzComponentProps } from "../../components/types"
import HeaderConstructor from "../../components/Header"
import BodyConstructor from "../../components/Body"
import { pageResources, renderPage } from "../../components/renderPage"
import { FullPageLayout } from "../../cfg"
-import { FilePath, canonicalizeServer } from "../../path"
+import { pathToRoot } from "../../util/path"
+import { defaultContentPageLayout, sharedPageComponents } from "../../../quartz.layout"
+import { Content } from "../../components"
+import { styleText } from "util"
+import { write } from "./helpers"
+import { BuildCtx } from "../../util/ctx"
+import { Node } from "unist"
+import { StaticResources } from "../../util/resources"
+import { QuartzPluginData } from "../vfile"
-export const ContentPage: QuartzEmitterPlugin<FullPageLayout> = (opts) => {
- if (!opts) {
- throw new Error("ContentPage must be initialized with options specifiying the components to use")
+async function processContent(
+ ctx: BuildCtx,
+ tree: Node,
+ fileData: QuartzPluginData,
+ allFiles: QuartzPluginData[],
+ opts: FullPageLayout,
+ resources: StaticResources,
+) {
+ const slug = fileData.slug!
+ const cfg = ctx.cfg.configuration
+ const externalResources = pageResources(pathToRoot(slug), resources)
+ const componentData: QuartzComponentProps = {
+ ctx,
+ fileData,
+ externalResources,
+ cfg,
+ children: [],
+ tree,
+ allFiles,
}
- const { head: Head, header, beforeBody, pageBody: Content, left, right, footer: Footer } = opts
+ const content = renderPage(cfg, slug, componentData, opts, externalResources)
+ return write({
+ ctx,
+ content,
+ slug,
+ ext: ".html",
+ })
+}
+
+export const ContentPage: QuartzEmitterPlugin<Partial<FullPageLayout>> = (userOpts) => {
+ const opts: FullPageLayout = {
+ ...sharedPageComponents,
+ ...defaultContentPageLayout,
+ pageBody: Content(),
+ ...userOpts,
+ }
+
+ const { head: Head, header, beforeBody, pageBody, afterBody, left, right, footer: Footer } = opts
const Header = HeaderConstructor()
const Body = BodyConstructor()
return {
name: "ContentPage",
getQuartzComponents() {
- return [Head, Header, Body, ...header, ...beforeBody, Content, ...left, ...right, Footer]
+ return [
+ Head,
+ Header,
+ Body,
+ ...header,
+ ...beforeBody,
+ pageBody,
+ ...afterBody,
+ ...left,
+ ...right,
+ Footer,
+ ]
},
- async emit(_contentDir, cfg, content, resources, emit): Promise<FilePath[]> {
- const fps: FilePath[] = []
- const allFiles = content.map(c => c[1].data)
+ async *emit(ctx, content, resources) {
+ const allFiles = content.map((c) => c[1].data)
+ let containsIndex = false
+
for (const [tree, file] of content) {
- const slug = canonicalizeServer(file.data.slug!)
- const externalResources = pageResources(slug, resources)
- const componentData: QuartzComponentProps = {
- fileData: file.data,
- externalResources,
- cfg,
- children: [],
- tree,
- allFiles
+ const slug = file.data.slug!
+ if (slug === "index") {
+ containsIndex = true
}
- const content = renderPage(
- slug,
- componentData,
- opts,
- externalResources
- )
-
- const fp = file.data.slug + ".html" as FilePath
- await emit({
- content,
- slug: file.data.slug!,
- ext: ".html",
- })
-
- fps.push(fp)
+ // only process home page, non-tag pages, and non-index pages
+ if (slug.endsWith("/index") || slug.startsWith("tags/")) continue
+ yield processContent(ctx, tree, file.data, allFiles, opts, resources)
}
- return fps
- }
+
+ if (!containsIndex) {
+ console.log(
+ styleText(
+ "yellow",
+ `\nWarning: you seem to be missing an \`index.md\` home page file at the root of your \`${ctx.argv.directory}\` folder (\`${path.join(ctx.argv.directory, "index.md")} does not exist\`). This may cause errors when deploying.`,
+ ),
+ )
+ }
+ },
+ async *partialEmit(ctx, content, resources, changeEvents) {
+ const allFiles = content.map((c) => c[1].data)
+
+ // find all slugs that changed or were added
+ const changedSlugs = new Set<string>()
+ for (const changeEvent of changeEvents) {
+ if (!changeEvent.file) continue
+ if (changeEvent.type === "add" || changeEvent.type === "change") {
+ changedSlugs.add(changeEvent.file.data.slug!)
+ }
+ }
+
+ for (const [tree, file] of content) {
+ const slug = file.data.slug!
+ if (!changedSlugs.has(slug)) continue
+ if (slug.endsWith("/index") || slug.startsWith("tags/")) continue
+
+ yield processContent(ctx, tree, file.data, allFiles, opts, resources)
+ }
+ },
}
}
--
Gitblit v1.10.0