| | |
| | | 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, |
| | | 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> = (userOpts) => { |
| | | interface FolderPageOptions extends FullPageLayout { |
| | | sort?: (f1: QuartzPluginData, f2: QuartzPluginData) => number |
| | | } |
| | | |
| | | export const FolderPage: QuartzEmitterPlugin<Partial<FolderPageOptions>> = (userOpts) => { |
| | | const opts: FullPageLayout = { |
| | | ...sharedPageComponents, |
| | | ...defaultListPageLayout, |
| | | pageBody: FolderContent(), |
| | | pageBody: FolderContent({ sort: userOpts?.sort }), |
| | | ...userOpts, |
| | | } |
| | | |
| | | const { head: Head, header, beforeBody, pageBody, 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, pageBody, ...left, ...right, Footer] |
| | | return [ |
| | | Head, |
| | | Header, |
| | | Body, |
| | | ...header, |
| | | ...beforeBody, |
| | | pageBody, |
| | | ...afterBody, |
| | | ...left, |
| | | ...right, |
| | | Footer, |
| | | ] |
| | | }, |
| | | async emit(ctx, content, resources, emit): Promise<FilePath[]> { |
| | | 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[] = [] |
| | | const allFiles = content.map((c) => c[1].data) |
| | | const cfg = ctx.cfg.configuration |
| | | |
| | | const folders: Set<CanonicalSlug> = new Set( |
| | | const folders: Set<SimpleSlug> = new Set( |
| | | allFiles.flatMap((data) => { |
| | | const slug = data.slug |
| | | const folderName = path.dirname(slug ?? "") as CanonicalSlug |
| | | if (slug && folderName !== "." && folderName !== "tags") { |
| | | return [folderName] |
| | | } |
| | | return [] |
| | | return data.slug |
| | | ? _getFolders(data.slug).filter( |
| | | (folderName) => folderName !== "." && folderName !== "tags", |
| | | ) |
| | | : [] |
| | | }), |
| | | ) |
| | | |
| | |
| | | [...folders].map((folder) => [ |
| | | folder, |
| | | defaultProcessedContent({ |
| | | slug: joinSegments(folder, "index") as ServerSlug, |
| | | frontmatter: { title: `Folder: ${folder}`, tags: [] }, |
| | | 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, |
| | |
| | | allFiles, |
| | | } |
| | | |
| | | const content = renderPage(slug, componentData, opts, externalResources) |
| | | const fp = await emit({ |
| | | const content = renderPage(cfg, slug, componentData, opts, externalResources) |
| | | const fp = await write({ |
| | | ctx, |
| | | content, |
| | | slug: file.data.slug!, |
| | | slug, |
| | | ext: ".html", |
| | | }) |
| | | |
| | |
| | | }, |
| | | } |
| | | } |
| | | |
| | | 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 |
| | | } |