From 4e4930ef9c2e2ddb9bcb1436660d3a3002c19844 Mon Sep 17 00:00:00 2001
From: Anton Bulakh <him@necauq.ua>
Date: Fri, 24 Jan 2025 03:19:46 +0000
Subject: [PATCH] chore(styles): omit sass deprecation warnings (#1737)
---
quartz/components/renderPage.tsx | 124 +++++++++++++++++++++++++++++------------
1 files changed, 87 insertions(+), 37 deletions(-)
diff --git a/quartz/components/renderPage.tsx b/quartz/components/renderPage.tsx
index 02db2b0..3914411 100644
--- a/quartz/components/renderPage.tsx
+++ b/quartz/components/renderPage.tsx
@@ -3,9 +3,14 @@
import HeaderConstructor from "./Header"
import BodyConstructor from "./Body"
import { JSResourceToScriptElement, StaticResources } from "../util/resources"
-import { FullSlug, RelativeURL, joinSegments, normalizeHastElement } from "../util/path"
+import { clone, FullSlug, RelativeURL, joinSegments, normalizeHastElement } from "../util/path"
import { visit } from "unist-util-visit"
import { Root, Element, ElementContent } from "hast"
+import { GlobalConfiguration } from "../cfg"
+import { i18n } from "../i18n"
+// @ts-ignore
+import mermaidScript from "./scripts/mermaid.inline"
+import mermaidStyle from "./styles/mermaid.inline.scss"
import { QuartzPluginData } from "../plugins/vfile"
interface RenderComponents {
@@ -13,20 +18,28 @@
header: QuartzComponent[]
beforeBody: QuartzComponent[]
pageBody: QuartzComponent
+ afterBody: QuartzComponent[]
left: QuartzComponent[]
right: QuartzComponent[]
footer: QuartzComponent
}
+const headerRegex = new RegExp(/h[1-6]/)
export function pageResources(
baseDir: FullSlug | RelativeURL,
+ fileData: QuartzPluginData,
staticResources: StaticResources,
): StaticResources {
const contentIndexPath = joinSegments(baseDir, "static/contentIndex.json")
- const contentIndexScript = `const fetchData = fetch(\`${contentIndexPath}\`).then(data => data.json())`
+ const contentIndexScript = `const fetchData = fetch("${contentIndexPath}").then(data => data.json())`
- return {
- css: [joinSegments(baseDir, "index.css"), ...staticResources.css],
+ const resources: StaticResources = {
+ css: [
+ {
+ content: joinSegments(baseDir, "index.css"),
+ },
+ ...staticResources.css,
+ ],
js: [
{
src: joinSegments(baseDir, "prescript.js"),
@@ -40,42 +53,49 @@
script: contentIndexScript,
},
...staticResources.js,
- {
- src: joinSegments(baseDir, "postscript.js"),
- loadTime: "afterDOMReady",
- moduleType: "module",
- contentType: "external",
- },
],
}
-}
-let pageIndex: Map<FullSlug, QuartzPluginData> | undefined = undefined
-function getOrComputeFileIndex(allFiles: QuartzPluginData[]): Map<FullSlug, QuartzPluginData> {
- if (!pageIndex) {
- pageIndex = new Map()
- for (const file of allFiles) {
- pageIndex.set(file.slug!, file)
- }
+ if (fileData.hasMermaidDiagram) {
+ resources.js.push({
+ script: mermaidScript,
+ loadTime: "afterDOMReady",
+ moduleType: "module",
+ contentType: "inline",
+ })
+ resources.css.push({ content: mermaidStyle, inline: true })
}
- return pageIndex
+ // NOTE: we have to put this last to make sure spa.inline.ts is the last item.
+ resources.js.push({
+ src: joinSegments(baseDir, "postscript.js"),
+ loadTime: "afterDOMReady",
+ moduleType: "module",
+ contentType: "external",
+ })
+
+ return resources
}
export function renderPage(
+ cfg: GlobalConfiguration,
slug: FullSlug,
componentData: QuartzComponentProps,
components: RenderComponents,
pageResources: StaticResources,
): string {
+ // make a deep copy of the tree so we don't remove the transclusion references
+ // for the file cached in contentMap in build.ts
+ const root = clone(componentData.tree) as Root
+
// process transcludes in componentData
- visit(componentData.tree as Root, "element", (node, _index, _parent) => {
+ visit(root, "element", (node, _index, _parent) => {
if (node.tagName === "blockquote") {
const classNames = (node.properties?.className ?? []) as string[]
if (classNames.includes("transclude")) {
const inner = node.children[0] as Element
const transcludeTarget = inner.properties["data-slug"] as FullSlug
- const page = getOrComputeFileIndex(componentData.allFiles).get(transcludeTarget)
+ const page = componentData.allFiles.find((f) => f.slug === transcludeTarget)
if (!page) {
return
}
@@ -100,8 +120,10 @@
{
type: "element",
tagName: "a",
- properties: { href: inner.properties?.href, class: ["internal"] },
- children: [{ type: "text", value: `Link to original` }],
+ properties: { href: inner.properties?.href, class: ["internal", "transclude-src"] },
+ children: [
+ { type: "text", value: i18n(cfg.locale).components.transcludes.linkToOriginal },
+ ],
},
]
}
@@ -109,18 +131,24 @@
// header transclude
blockRef = blockRef.slice(1)
let startIdx = undefined
+ let startDepth = undefined
let endIdx = undefined
for (const [i, el] of page.htmlAst.children.entries()) {
- if (el.type === "element" && el.tagName.match(/h[1-6]/)) {
- if (endIdx) {
- break
- }
+ // skip non-headers
+ if (!(el.type === "element" && el.tagName.match(headerRegex))) continue
+ const depth = Number(el.tagName.substring(1))
- if (startIdx !== undefined) {
- endIdx = i
- } else if (el.properties?.id === blockRef) {
+ // lookin for our blockref
+ if (startIdx === undefined || startDepth === undefined) {
+ // skip until we find the blockref that matches
+ if (el.properties?.id === blockRef) {
startIdx = i
+ startDepth = depth
}
+ } else if (depth <= startDepth) {
+ // looking for new header that is same level or higher
+ endIdx = i
+ break
}
}
@@ -135,8 +163,10 @@
{
type: "element",
tagName: "a",
- properties: { href: inner.properties?.href, class: ["internal"] },
- children: [{ type: "text", value: `Link to original` }],
+ properties: { href: inner.properties?.href, class: ["internal", "transclude-src"] },
+ children: [
+ { type: "text", value: i18n(cfg.locale).components.transcludes.linkToOriginal },
+ ],
},
]
} else if (page.htmlAst) {
@@ -147,7 +177,14 @@
tagName: "h1",
properties: {},
children: [
- { type: "text", value: page.frontmatter?.title ?? `Transclude of ${page.slug}` },
+ {
+ type: "text",
+ value:
+ page.frontmatter?.title ??
+ i18n(cfg.locale).components.transcludes.transcludeOf({
+ targetSlug: page.slug!,
+ }),
+ },
],
},
...(page.htmlAst.children as ElementContent[]).map((child) =>
@@ -156,8 +193,10 @@
{
type: "element",
tagName: "a",
- properties: { href: inner.properties?.href, class: ["internal"] },
- children: [{ type: "text", value: `Link to original` }],
+ properties: { href: inner.properties?.href, class: ["internal", "transclude-src"] },
+ children: [
+ { type: "text", value: i18n(cfg.locale).components.transcludes.linkToOriginal },
+ ],
},
]
}
@@ -165,11 +204,15 @@
}
})
+ // set componentData.tree to the edited html that has transclusions rendered
+ componentData.tree = root
+
const {
head: Head,
header,
beforeBody,
pageBody: Content,
+ afterBody,
left,
right,
footer: Footer,
@@ -193,8 +236,9 @@
</div>
)
+ const lang = componentData.fileData.frontmatter?.lang ?? cfg.locale?.split("-")[0] ?? "en"
const doc = (
- <html>
+ <html lang={lang}>
<Head {...componentData} />
<body data-slug={slug}>
<div id="quartz-root" class="page">
@@ -214,10 +258,16 @@
</div>
</div>
<Content {...componentData} />
+ <hr />
+ <div class="page-footer">
+ {afterBody.map((BodyComponent) => (
+ <BodyComponent {...componentData} />
+ ))}
+ </div>
</div>
{RightComponent}
+ <Footer {...componentData} />
</Body>
- <Footer {...componentData} />
</div>
</body>
{pageResources.js
--
Gitblit v1.10.0