| | |
| | | import { JSResourceToScriptElement, StaticResources } from "../../resources" |
| | | import path from "path" |
| | | import { QuartzEmitterPlugin } from "../types" |
| | | import { render } from "preact-render-to-string" |
| | | import { QuartzComponent } from "../../components/types" |
| | | import { resolveToRoot } from "../../path" |
| | | import HeaderConstructor from "../../components/Header" |
| | | import { QuartzComponentProps } from "../../components/types" |
| | | import HeaderConstructor from "../../components/Header" |
| | | import BodyConstructor from "../../components/Body" |
| | | import ContentConstructor from "../../components/Content" |
| | | import { pageResources, renderPage } from "../../components/renderPage" |
| | | import { FullPageLayout } from "../../cfg" |
| | | 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" |
| | | |
| | | interface Options { |
| | | head: QuartzComponent |
| | | header: QuartzComponent[], |
| | | beforeBody: QuartzComponent[], |
| | | left: QuartzComponent[], |
| | | right: QuartzComponent[], |
| | | footer: QuartzComponent[], |
| | | } |
| | | |
| | | export const ContentPage: QuartzEmitterPlugin<Options> = (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, left, right, 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() |
| | | const Content = ContentConstructor() |
| | | |
| | | return { |
| | | name: "ContentPage", |
| | | getQuartzComponents() { |
| | | return [opts.head, Header, Body, ...opts.header, ...opts.beforeBody, ...opts.left, ...opts.right, ...opts.footer] |
| | | return [ |
| | | Head, |
| | | Header, |
| | | Body, |
| | | ...header, |
| | | ...beforeBody, |
| | | pageBody, |
| | | ...afterBody, |
| | | ...left, |
| | | ...right, |
| | | Footer, |
| | | ] |
| | | }, |
| | | async emit(_contentDir, cfg, content, resources, emit): Promise<string[]> { |
| | | const fps: string[] = [] |
| | | async *emit(ctx, content, resources) { |
| | | const allFiles = content.map((c) => c[1].data) |
| | | let containsIndex = false |
| | | |
| | | for (const [tree, file] of content) { |
| | | const baseDir = resolveToRoot(file.data.slug!) |
| | | const pageResources: StaticResources = { |
| | | css: [baseDir + "/index.css", ...resources.css], |
| | | js: [ |
| | | { src: baseDir + "/prescript.js", loadTime: "beforeDOMReady", contentType: "external" }, |
| | | ...resources.js, |
| | | { src: baseDir + "/postscript.js", loadTime: "afterDOMReady", moduleType: 'module', contentType: "external" } |
| | | ] |
| | | const slug = file.data.slug! |
| | | if (slug === "index") { |
| | | containsIndex = true |
| | | } |
| | | |
| | | const componentData: QuartzComponentProps = { |
| | | fileData: file.data, |
| | | externalResources: pageResources, |
| | | cfg, |
| | | children: [], |
| | | tree |
| | | } |
| | | |
| | | const doc = <html> |
| | | <Head {...componentData} /> |
| | | <body data-slug={file.data.slug}> |
| | | <div id="quartz-root" class="page"> |
| | | <Header {...componentData} > |
| | | {header.map(HeaderComponent => <HeaderComponent {...componentData} />)} |
| | | </Header> |
| | | {beforeBody.map(BodyComponent => <BodyComponent {...componentData} />)} |
| | | <Body {...componentData}> |
| | | <div class="left"> |
| | | {left.map(BodyComponent => <BodyComponent {...componentData} />)} |
| | | </div> |
| | | <div class="center"> |
| | | <Content {...componentData} /> |
| | | </div> |
| | | <div class="right"> |
| | | {right.map(BodyComponent => <BodyComponent {...componentData} />)} |
| | | </div> |
| | | </Body> |
| | | |
| | | </div> |
| | | </body> |
| | | {pageResources.js.filter(resource => resource.loadTime === "afterDOMReady").map(res => JSResourceToScriptElement(res))} |
| | | </html> |
| | | |
| | | const fp = file.data.slug + ".html" |
| | | await emit({ |
| | | content: "<!DOCTYPE html>\n" + render(doc), |
| | | 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) |
| | | } |
| | | }, |
| | | } |
| | | } |