Merge branch 'v4' of https://github.com/jackyzha0/quartz into v4

plastic-labs · Nov 20, 2023 · b53d22c · b53d22c
2 parents 99e713d + 9a599ae
commit b53d22c
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 26 deletions.
diff --git a/docs/features/breadcrumbs.md b/docs/features/breadcrumbs.md
@@ -20,6 +20,7 @@ Component.Breadcrumbs({
   rootName: "Home", // name of first/root element
   resolveFrontmatterTitle: true, // whether to resolve folder names through frontmatter titles
   hideOnRoot: true, // whether to hide breadcrumbs on root `index.md` page
+  showCurrentPage: true, // wether to display the current page in the breadcrumbs
 })
 ```
 

diff --git a/quartz/components/Breadcrumbs.tsx b/quartz/components/Breadcrumbs.tsx
@@ -25,13 +25,18 @@ interface BreadcrumbOptions {
    * Wether to display breadcrumbs on root `index.md`
    */
   hideOnRoot: boolean
+  /**
+   * Wether to display the current page in the breadcrumbs.
+   */
+  showCurrentPage: boolean
 }
 
 const defaultOptions: BreadcrumbOptions = {
   spacerSymbol: "❯",
   rootName: "Home",
   resolveFrontmatterTitle: true,
   hideOnRoot: true,
+  showCurrentPage: true,
 }
 
 function formatCrumb(displayName: string, baseSlug: FullSlug, currentSlug: SimpleSlug): CrumbData {
@@ -95,10 +100,12 @@ export default ((opts?: Partial<BreadcrumbOptions>) => {
       }
 
       // Add current file to crumb (can directly use frontmatter title)
-      crumbs.push({
-        displayName: fileData.frontmatter!.title,
-        path: "",
-      })
+      if (options.showCurrentPage) {
+        crumbs.push({
+          displayName: fileData.frontmatter!.title,
+          path: "",
+        })
+      }
     }
     return (
       <nav class={`breadcrumb-container ${displayClass ?? ""}`} aria-label="breadcrumbs">

diff --git a/quartz/components/renderPage.tsx b/quartz/components/renderPage.tsx
@@ -104,15 +104,15 @@ export function renderPage(
                 break
               }
 
-              if (startIdx) {
+              if (startIdx !== undefined) {
                 endIdx = i
               } else if (el.properties?.id === blockRef) {
                 startIdx = i
               }
             }
           }
 
-          if (!startIdx) {
+          if (startIdx === undefined) {
             return
           }
 

diff --git a/quartz/components/scripts/popover.inline.ts b/quartz/components/scripts/popover.inline.ts
@@ -1,20 +1,5 @@
 import { computePosition, flip, inline, shift } from "@floating-ui/dom"
-
-// from micromorph/src/utils.ts
-// https://github.com/natemoo-re/micromorph/blob/main/src/utils.ts#L5
-export function normalizeRelativeURLs(el: Element | Document, destination: string | URL) {
-  const rebase = (el: Element, attr: string, newBase: string | URL) => {
-    const rebased = new URL(el.getAttribute(attr)!, newBase)
-    el.setAttribute(attr, rebased.pathname + rebased.hash)
-  }
-
-  el.querySelectorAll('[href^="./"], [href^="../"]').forEach((item) =>
-    rebase(item, "href", destination),
-  )
-  el.querySelectorAll('[src^="./"], [src^="../"]').forEach((item) =>
-    rebase(item, "src", destination),
-  )
-}
+import { normalizeRelativeURLs } from "../../util/path"
 
 const p = new DOMParser()
 async function mouseEnterHandler(

diff --git a/quartz/components/scripts/spa.inline.ts b/quartz/components/scripts/spa.inline.ts
@@ -1,10 +1,8 @@
 import micromorph from "micromorph"
-import { FullSlug, RelativeURL, getFullSlug } from "../../util/path"
-import { normalizeRelativeURLs } from "./popover.inline"
+import { FullSlug, RelativeURL, getFullSlug, normalizeRelativeURLs } from "../../util/path"
 
 // adapted from `micromorph`
 // https://github.com/natemoo-re/micromorph
-
 const NODE_TYPE_ELEMENT = 1
 let announcer = document.createElement("route-announcer")
 const isElement = (target: EventTarget | null): target is Element =>

diff --git a/quartz/plugins/transformers/ofm.ts b/quartz/plugins/transformers/ofm.ts
@@ -183,7 +183,7 @@ export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin<Partial<Options>
           const fp = rawFp ?? ""
           const anchor = rawHeader?.trim().replace(/^#+/, "")
           const displayAnchor = anchor ? `#${slugAnchor(anchor)}` : ""
-          const displayAlias = rawAlias ?? anchor ?? ""
+          const displayAlias = rawAlias ?? rawHeader?.replace("#", "|") ?? ""
           const embedDisplay = value.startsWith("!") ? "!" : ""
           return `${embedDisplay}[[${fp}${displayAnchor}${displayAlias}]]`
         })

diff --git a/quartz/util/path.ts b/quartz/util/path.ts
@@ -84,6 +84,22 @@ export function transformInternalLink(link: string): RelativeURL {
   return res
 }
 
+// from micromorph/src/utils.ts
+// https://github.com/natemoo-re/micromorph/blob/main/src/utils.ts#L5
+export function normalizeRelativeURLs(el: Element | Document, destination: string | URL) {
+  const rebase = (el: Element, attr: string, newBase: string | URL) => {
+    const rebased = new URL(el.getAttribute(attr)!, newBase)
+    el.setAttribute(attr, rebased.pathname + rebased.hash)
+  }
+
+  el.querySelectorAll('[href^="./"], [href^="../"]').forEach((item) =>
+    rebase(item, "href", destination),
+  )
+  el.querySelectorAll('[src^="./"], [src^="../"]').forEach((item) =>
+    rebase(item, "src", destination),
+  )
+}
+
 // resolve /a/b/c to ../..
 export function pathToRoot(slug: FullSlug): RelativeURL {
   let rootPath = slug