From b9dee0775cda4bb29da1a5fb5b000ddcd4dc1f6e Mon Sep 17 00:00:00 2001
From: kon-foo <25391223+kon-foo@users.noreply.github.com>
Date: Mon, 26 Feb 2024 21:55:47 +0000
Subject: [PATCH] docs: Clarifications in the Explorer Docs (#938)
---
quartz/plugins/emitters/tagPage.tsx | 71 ++++++++++++++++++++++++++---------
1 files changed, 52 insertions(+), 19 deletions(-)
diff --git a/quartz/plugins/emitters/tagPage.tsx b/quartz/plugins/emitters/tagPage.tsx
index 2154851..6f65ae4 100644
--- a/quartz/plugins/emitters/tagPage.tsx
+++ b/quartz/plugins/emitters/tagPage.tsx
@@ -6,28 +6,57 @@
import { ProcessedContent, defaultProcessedContent } from "../vfile"
import { FullPageLayout } from "../../cfg"
import {
- CanonicalSlug,
FilePath,
- ServerSlug,
+ FullSlug,
getAllSegmentPrefixes,
joinSegments,
-} from "../../path"
+ pathToRoot,
+} from "../../util/path"
+import { defaultListPageLayout, sharedPageComponents } from "../../../quartz.layout"
+import { TagContent } from "../../components"
+import { write } from "./helpers"
+import { i18n } from "../../i18n"
+import DepGraph from "../../depgraph"
-export const TagPage: QuartzEmitterPlugin<FullPageLayout> = (opts) => {
- if (!opts) {
- throw new Error("TagPage must be initialized with options specifiying the components to use")
+export const TagPage: QuartzEmitterPlugin<Partial<FullPageLayout>> = (userOpts) => {
+ const opts: FullPageLayout = {
+ ...sharedPageComponents,
+ ...defaultListPageLayout,
+ pageBody: TagContent(),
+ ...userOpts,
}
- const { head: Head, header, beforeBody, pageBody: Content, left, right, footer: Footer } = opts
+ const { head: Head, header, beforeBody, pageBody, left, right, footer: Footer } = opts
const Header = HeaderConstructor()
const Body = BodyConstructor()
return {
name: "TagPage",
getQuartzComponents() {
- return [Head, Header, Body, ...header, ...beforeBody, Content, ...left, ...right, Footer]
+ return [Head, Header, Body, ...header, ...beforeBody, pageBody, ...left, ...right, Footer]
},
- async emit(ctx, content, resources, emit): Promise<FilePath[]> {
+ async getDependencyGraph(ctx, content, _resources) {
+ const graph = new DepGraph<FilePath>()
+
+ for (const [_tree, file] of content) {
+ const sourcePath = file.data.filePath!
+ const tags = (file.data.frontmatter?.tags ?? []).flatMap(getAllSegmentPrefixes)
+ // if the file has at least one tag, it is used in the tag index page
+ if (tags.length > 0) {
+ tags.push("index")
+ }
+
+ for (const tag of tags) {
+ graph.addEdge(
+ sourcePath,
+ joinSegments(ctx.argv.output, "tags", tag + ".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
@@ -35,16 +64,20 @@
const tags: Set<string> = new Set(
allFiles.flatMap((data) => data.frontmatter?.tags ?? []).flatMap(getAllSegmentPrefixes),
)
+
// add base tag
- tags.add("")
+ tags.add("index")
const tagDescriptions: Record<string, ProcessedContent> = Object.fromEntries(
[...tags].map((tag) => {
- const title = tag === "" ? "Tag Index" : `Tag: #${tag}`
+ const title =
+ tag === "index"
+ ? i18n(cfg.locale).pages.tagContent.tagIndex
+ : `${i18n(cfg.locale).pages.tagContent.tag}: #${tag}`
return [
tag,
defaultProcessedContent({
- slug: joinSegments("tags", tag, "index") as ServerSlug,
+ slug: joinSegments("tags", tag) as FullSlug,
frontmatter: { title, tags: [] },
}),
]
@@ -54,7 +87,7 @@
for (const [tree, file] of content) {
const slug = file.data.slug!
if (slug.startsWith("tags/")) {
- const tag = joinSegments(slug.slice("tags/".length), "index")
+ const tag = slug.slice("tags/".length)
if (tags.has(tag)) {
tagDescriptions[tag] = [tree, file]
}
@@ -62,10 +95,11 @@
}
for (const tag of tags) {
- const slug = joinSegments("tags", tag) as CanonicalSlug
- const externalResources = pageResources(slug, resources)
+ const slug = joinSegments("tags", tag) as FullSlug
+ const externalResources = pageResources(pathToRoot(slug), resources)
const [tree, file] = tagDescriptions[tag]
const componentData: QuartzComponentProps = {
+ ctx,
fileData: file.data,
externalResources,
cfg,
@@ -74,10 +108,9 @@
allFiles,
}
- const content = renderPage(slug, componentData, opts, externalResources)
-
- const fp = (file.data.slug + ".html") as FilePath
- await emit({
+ const content = renderPage(cfg, slug, componentData, opts, externalResources)
+ const fp = await write({
+ ctx,
content,
slug: file.data.slug!,
ext: ".html",
--
Gitblit v1.10.0