From ef72f1bf707dca363cdab84da91e2acfaef8f276 Mon Sep 17 00:00:00 2001
From: Ammar Alakkad <am.alakkad@gmail.com>
Date: Mon, 30 Dec 2024 16:03:57 +0000
Subject: [PATCH] Fix ObsidianFlavoredMarkdown source link (#1694)
---
quartz/plugins/emitters/contentPage.tsx | 173 ++++++++++++++++++++++++++++++++++++---------------------
1 files changed, 109 insertions(+), 64 deletions(-)
diff --git a/quartz/plugins/emitters/contentPage.tsx b/quartz/plugins/emitters/contentPage.tsx
index 03bc0ff..2ac1321 100644
--- a/quartz/plugins/emitters/contentPage.tsx
+++ b/quartz/plugins/emitters/contentPage.tsx
@@ -1,97 +1,142 @@
-import { JSResourceToScriptElement, StaticResources } from "../../resources"
+import path from "path"
+import { visit } from "unist-util-visit"
+import { Root } from "hast"
+import { VFile } from "vfile"
import { QuartzEmitterPlugin } from "../types"
-import { render } from "preact-render-to-string"
-import { QuartzComponent } from "../../components/types"
-import { resolveToRoot, trimPathSuffix } from "../../path"
-import HeaderConstructor from "../../components/Header"
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 { Argv } from "../../util/ctx"
+import { FilePath, isRelativeURL, joinSegments, pathToRoot } from "../../util/path"
+import { defaultContentPageLayout, sharedPageComponents } from "../../../quartz.layout"
+import { Content } from "../../components"
+import chalk from "chalk"
+import { write } from "./helpers"
+import DepGraph from "../../depgraph"
-interface Options {
- head: QuartzComponent
- header: QuartzComponent[],
- beforeBody: QuartzComponent[],
- content: QuartzComponent,
- left: QuartzComponent[],
- right: QuartzComponent[],
- footer: QuartzComponent[],
+// get all the dependencies for the markdown file
+// eg. images, scripts, stylesheets, transclusions
+const parseDependencies = (argv: Argv, hast: Root, file: VFile): string[] => {
+ const dependencies: string[] = []
+
+ visit(hast, "element", (elem): void => {
+ let ref: string | null = null
+
+ if (
+ ["script", "img", "audio", "video", "source", "iframe"].includes(elem.tagName) &&
+ elem?.properties?.src
+ ) {
+ ref = elem.properties.src.toString()
+ } else if (["a", "link"].includes(elem.tagName) && elem?.properties?.href) {
+ // transclusions will create a tags with relative hrefs
+ ref = elem.properties.href.toString()
+ }
+
+ // if it is a relative url, its a local file and we need to add
+ // it to the dependency graph. otherwise, ignore
+ if (ref === null || !isRelativeURL(ref)) {
+ return
+ }
+
+ let fp = path.join(file.data.filePath!, path.relative(argv.directory, ref)).replace(/\\/g, "/")
+ // markdown files have the .md extension stripped in hrefs, add it back here
+ if (!fp.split("/").pop()?.includes(".")) {
+ fp += ".md"
+ }
+ dependencies.push(fp)
+ })
+
+ return dependencies
}
-export const ContentPage: QuartzEmitterPlugin<Options> = (opts) => {
- if (!opts) {
- throw new Error("ContentPage must be initialized with options specifiying the components to use")
+export const ContentPage: QuartzEmitterPlugin<Partial<FullPageLayout>> = (userOpts) => {
+ const opts: FullPageLayout = {
+ ...sharedPageComponents,
+ ...defaultContentPageLayout,
+ pageBody: Content(),
+ ...userOpts,
}
- const { head: Head, header, beforeBody, left, right, footer } = opts
+ const { head: Head, header, beforeBody, pageBody, afterBody, left, right, footer: Footer } = opts
const Header = HeaderConstructor()
const Body = BodyConstructor()
return {
name: "ContentPage",
getQuartzComponents() {
- return [opts.head, Header, Body, ...opts.header, ...opts.beforeBody, opts.content, ...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[] = []
- const allFiles = content.map(c => c[1].data)
+ async getDependencyGraph(ctx, content, _resources) {
+ const graph = new DepGraph<FilePath>()
+
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 sourcePath = file.data.filePath!
+ const slug = file.data.slug!
+ graph.addEdge(sourcePath, joinSegments(ctx.argv.output, slug + ".html") as FilePath)
+
+ parseDependencies(ctx.argv, tree as Root, file).forEach((dep) => {
+ graph.addEdge(dep as FilePath, sourcePath)
+ })
+ }
+
+ return graph
+ },
+ async emit(ctx, content, resources): Promise<FilePath[]> {
+ const cfg = ctx.cfg.configuration
+ const fps: FilePath[] = []
+ const allFiles = content.map((c) => c[1].data)
+
+ let containsIndex = false
+ for (const [tree, file] of content) {
+ const slug = file.data.slug!
+ if (slug === "index") {
+ containsIndex = true
}
+ const externalResources = pageResources(pathToRoot(slug), resources)
const componentData: QuartzComponentProps = {
+ ctx,
fileData: file.data,
- externalResources: pageResources,
+ externalResources,
cfg,
children: [],
tree,
- allFiles
+ allFiles,
}
- const Content = opts.content
- 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>
- <div class="popover-hint">
- {beforeBody.map(BodyComponent => <BodyComponent {...componentData} />)}
- </div>
- <Body {...componentData}>
- <div class="left">
- {left.map(BodyComponent => <BodyComponent {...componentData} />)}
- </div>
- <div class="center popover-hint">
- <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!,
+ const content = renderPage(cfg, slug, componentData, opts, externalResources)
+ const fp = await write({
+ ctx,
+ content,
+ slug,
ext: ".html",
})
fps.push(fp)
}
+
+ if (!containsIndex && !ctx.argv.fastRebuild) {
+ console.log(
+ chalk.yellow(
+ `\nWarning: you seem to be missing an \`index.md\` home page file at the root of your \`${ctx.argv.directory}\` folder. This may cause errors when deploying.`,
+ ),
+ )
+ }
+
return fps
- }
+ },
}
}
--
Gitblit v1.10.0