quartz-research-note/quartz/plugins/emitters/folderPage.tsx

136 lines
4.0 KiB
TypeScript
Raw Normal View History

2023-07-01 07:03:01 +00:00
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 { ProcessedContent, QuartzPluginData, defaultProcessedContent } from "../vfile"
2023-07-01 07:03:01 +00:00
import { FullPageLayout } from "../../cfg"
import path from "path"
import {
FilePath,
FullSlug,
SimpleSlug,
stripSlashes,
joinSegments,
pathToRoot,
simplifySlug,
} from "../../util/path"
2023-07-26 06:37:24 +00:00
import { defaultListPageLayout, sharedPageComponents } from "../../../quartz.layout"
import { FolderContent } from "../../components"
import { write } from "./helpers"
import { i18n } from "../../i18n"
import DepGraph from "../../depgraph"
2023-07-01 07:03:01 +00:00
interface FolderPageOptions extends FullPageLayout {
sort?: (f1: QuartzPluginData, f2: QuartzPluginData) => number
}
export const FolderPage: QuartzEmitterPlugin<Partial<FolderPageOptions>> = (userOpts) => {
2023-07-26 06:37:24 +00:00
const opts: FullPageLayout = {
...sharedPageComponents,
...defaultListPageLayout,
pageBody: FolderContent({ sort: userOpts?.sort }),
2023-07-26 06:37:24 +00:00
...userOpts,
2023-07-01 07:03:01 +00:00
}
2024-07-10 02:09:31 +00:00
const { head: Head, header, beforeBody, pageBody, afterBody, left, right, footer: Footer } = opts
2023-07-01 07:03:01 +00:00
const Header = HeaderConstructor()
const Body = BodyConstructor()
return {
name: "FolderPage",
getQuartzComponents() {
2024-07-10 02:09:31 +00:00
return [
Head,
Header,
Body,
...header,
...beforeBody,
pageBody,
...afterBody,
...left,
...right,
Footer,
]
2023-07-01 07:03:01 +00:00
},
async getDependencyGraph(_ctx, content, _resources) {
// Example graph:
// nested/file.md --> nested/index.html
// nested/file2.md ------^
const graph = new DepGraph<FilePath>()
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 graph
},
async emit(ctx, content, resources): Promise<FilePath[]> {
const fps: FilePath[] = []
2023-07-23 00:27:41 +00:00
const allFiles = content.map((c) => c[1].data)
const cfg = ctx.cfg.configuration
2023-07-01 07:03:01 +00:00
const folders: Set<SimpleSlug> = new Set(
2023-07-23 00:27:41 +00:00
allFiles.flatMap((data) => {
const slug = data.slug
const folderName = path.dirname(slug ?? "") as SimpleSlug
2023-07-23 00:27:41 +00:00
if (slug && folderName !== "." && folderName !== "tags") {
return [folderName]
}
return []
}),
)
2023-07-01 07:03:01 +00:00
2023-07-23 00:27:41 +00:00
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: [],
},
2023-07-23 00:27:41 +00:00
}),
]),
)
2023-07-01 07:03:01 +00:00
for (const [tree, file] of content) {
const slug = stripSlashes(simplifySlug(file.data.slug!)) as SimpleSlug
2023-07-01 07:03:01 +00:00
if (folders.has(slug)) {
folderDescriptions[slug] = [tree, file]
}
}
for (const folder of folders) {
const slug = joinSegments(folder, "index") as FullSlug
const externalResources = pageResources(pathToRoot(slug), resources)
2023-07-01 07:03:01 +00:00
const [tree, file] = folderDescriptions[folder]
const componentData: QuartzComponentProps = {
ctx,
2023-07-01 07:03:01 +00:00
fileData: file.data,
externalResources,
cfg,
children: [],
tree,
2023-07-23 00:27:41 +00:00
allFiles,
2023-07-01 07:03:01 +00:00
}
const content = renderPage(cfg, slug, componentData, opts, externalResources)
const fp = await write({
ctx,
2023-07-01 07:03:01 +00:00
content,
slug,
2023-07-01 07:03:01 +00:00
ext: ".html",
})
fps.push(fp)
}
return fps
2023-07-23 00:27:41 +00:00
},
2023-07-01 07:03:01 +00:00
}
}