From 9c8fec06d2b58e4e3bbe280ddc665a99fcc4878c Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Sun, 09 Mar 2025 22:33:15 +0000
Subject: [PATCH] feat: support non-singleton search
---
quartz/plugins/emitters/folderPage.tsx | 135 ++++++++++++++++++++++++++++++++------------
1 files changed, 98 insertions(+), 37 deletions(-)
diff --git a/quartz/plugins/emitters/folderPage.tsx b/quartz/plugins/emitters/folderPage.tsx
index 7ac6d81..bafaec9 100644
--- a/quartz/plugins/emitters/folderPage.tsx
+++ b/quartz/plugins/emitters/folderPage.tsx
@@ -3,82 +3,143 @@
import HeaderConstructor from "../../components/Header"
import BodyConstructor from "../../components/Body"
import { pageResources, renderPage } from "../../components/renderPage"
-import { ProcessedContent, defaultProcessedContent } from "../vfile"
+import { ProcessedContent, QuartzPluginData, defaultProcessedContent } from "../vfile"
import { FullPageLayout } from "../../cfg"
import path from "path"
-import { CanonicalSlug, FilePath, ServerSlug, canonicalizeServer, joinSegments } from "../../path"
+import {
+ FilePath,
+ FullSlug,
+ SimpleSlug,
+ stripSlashes,
+ joinSegments,
+ pathToRoot,
+ simplifySlug,
+} from "../../util/path"
+import { defaultListPageLayout, sharedPageComponents } from "../../../quartz.layout"
+import { FolderContent } from "../../components"
+import { write } from "./helpers"
+import { i18n } from "../../i18n"
+import DepGraph from "../../depgraph"
-export const FolderPage: QuartzEmitterPlugin<FullPageLayout> = (opts) => {
- if (!opts) {
- throw new Error("ErrorPage must be initialized with options specifiying the components to use")
+interface FolderPageOptions extends FullPageLayout {
+ sort?: (f1: QuartzPluginData, f2: QuartzPluginData) => number
+}
+
+export const FolderPage: QuartzEmitterPlugin<Partial<FolderPageOptions>> = (userOpts) => {
+ const opts: FullPageLayout = {
+ ...sharedPageComponents,
+ ...defaultListPageLayout,
+ pageBody: FolderContent({ sort: userOpts?.sort }),
+ ...userOpts,
}
- const { head: Head, header, beforeBody, pageBody: Content, left, right, footer: Footer } = opts
+ const { head: Head, header, beforeBody, pageBody, afterBody, left, right, footer: Footer } = opts
const Header = HeaderConstructor()
const Body = BodyConstructor()
return {
name: "FolderPage",
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 getDependencyGraph(_ctx, content, _resources) {
+ // Example graph:
+ // nested/file.md --> nested/index.html
+ // nested/file2.md ------^
+ const graph = new DepGraph<FilePath>()
- const folders: Set<CanonicalSlug> = new Set(allFiles.flatMap(data => {
- const slug = data.slug
- const folderName = path.dirname(slug ?? "") as CanonicalSlug
- if (slug && folderName !== ".") {
- return [folderName]
+ content.map(([_tree, vfile]) => {
+ const slug = vfile.data.slug
+ const folderName = path.dirname(slug ?? "") as SimpleSlug
+ if (slug && folderName !== "." && folderName !== "tags") {
+ graph.addEdge(vfile.data.filePath!, joinSegments(folderName, "index.html") as FilePath)
}
- return []
- }))
+ })
- // remove special prefixes
- folders.delete("tags" as CanonicalSlug)
+ return graph
+ },
+ async emit(ctx, content, resources): Promise<FilePath[]> {
+ const fps: FilePath[] = []
+ const allFiles = content.map((c) => c[1].data)
+ const cfg = ctx.cfg.configuration
- const folderDescriptions: Record<string, ProcessedContent> = Object.fromEntries([...folders].map(folder => ([
- folder, defaultProcessedContent({ slug: joinSegments(folder, "index") as ServerSlug, frontmatter: { title: `Folder: ${folder}`, tags: [] } })
- ])))
+ const folders: Set<SimpleSlug> = new Set(
+ allFiles.flatMap((data) => {
+ return data.slug
+ ? _getFolders(data.slug).filter(
+ (folderName) => folderName !== "." && folderName !== "tags",
+ )
+ : []
+ }),
+ )
+
+ const folderDescriptions: Record<string, ProcessedContent> = Object.fromEntries(
+ [...folders].map((folder) => [
+ folder,
+ defaultProcessedContent({
+ slug: joinSegments(folder, "index") as FullSlug,
+ frontmatter: {
+ title: `${i18n(cfg.locale).pages.folderContent.folder}: ${folder}`,
+ tags: [],
+ },
+ }),
+ ]),
+ )
for (const [tree, file] of content) {
- const slug = canonicalizeServer(file.data.slug!)
+ const slug = stripSlashes(simplifySlug(file.data.slug!)) as SimpleSlug
if (folders.has(slug)) {
folderDescriptions[slug] = [tree, file]
}
}
for (const folder of folders) {
- const slug = folder
- const externalResources = pageResources(slug, resources)
+ const slug = joinSegments(folder, "index") as FullSlug
const [tree, file] = folderDescriptions[folder]
+ const externalResources = pageResources(pathToRoot(slug), file.data, resources)
const componentData: QuartzComponentProps = {
+ ctx,
fileData: file.data,
externalResources,
cfg,
children: [],
tree,
- allFiles
+ allFiles,
}
- const content = renderPage(
- slug,
- componentData,
- opts,
- externalResources
- )
-
- const fp = file.data.slug! + ".html" as FilePath
- await emit({
+ const content = renderPage(cfg, slug, componentData, opts, externalResources)
+ const fp = await write({
+ ctx,
content,
- slug: file.data.slug!,
+ slug,
ext: ".html",
})
fps.push(fp)
}
return fps
- }
+ },
}
}
+
+function _getFolders(slug: FullSlug): SimpleSlug[] {
+ var folderName = path.dirname(slug ?? "") as SimpleSlug
+ const parentFolderNames = [folderName]
+
+ while (folderName !== ".") {
+ folderName = path.dirname(folderName ?? "") as SimpleSlug
+ parentFolderNames.push(folderName)
+ }
+ return parentFolderNames
+}
--
Gitblit v1.10.0