From e70312320f77e8ee362fd12c5dc5597cfb3cb1ae Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Sat, 13 Jan 2024 17:47:56 +0000
Subject: [PATCH] feat: improve default layout
---
quartz/plugins/transformers/links.ts | 76 ++++++++++++++++++++++++++++++-------
1 files changed, 61 insertions(+), 15 deletions(-)
diff --git a/quartz/plugins/transformers/links.ts b/quartz/plugins/transformers/links.ts
index d867039..50d2d1a 100644
--- a/quartz/plugins/transformers/links.ts
+++ b/quartz/plugins/transformers/links.ts
@@ -1,28 +1,33 @@
import { QuartzTransformerPlugin } from "../types"
import {
- CanonicalSlug,
+ FullSlug,
RelativeURL,
+ SimpleSlug,
TransformOptions,
_stripSlashes,
- canonicalizeServer,
- joinSegments,
+ simplifySlug,
splitAnchor,
transformLink,
} from "../../util/path"
import path from "path"
import { visit } from "unist-util-visit"
import isAbsoluteUrl from "is-absolute-url"
+import { Root } from "hast"
interface Options {
/** How to resolve Markdown paths */
markdownLinkResolution: TransformOptions["strategy"]
/** Strips folders from a link so that it looks nice */
prettyLinks: boolean
+ openLinksInNewTab: boolean
+ lazyLoad: boolean
}
const defaultOptions: Options = {
markdownLinkResolution: "absolute",
prettyLinks: true,
+ openLinksInNewTab: false,
+ lazyLoad: false,
}
export const CrawlLinks: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
@@ -32,9 +37,9 @@
htmlPlugins(ctx) {
return [
() => {
- return (tree, file) => {
- const curSlug = canonicalizeServer(file.data.slug!)
- const outgoing: Set<CanonicalSlug> = new Set()
+ return (tree: Root, file) => {
+ const curSlug = simplifySlug(file.data.slug!)
+ const outgoing: Set<SimpleSlug> = new Set()
const transformOptions: TransformOptions = {
strategy: opts.markdownLinkResolution,
@@ -49,20 +54,53 @@
typeof node.properties.href === "string"
) {
let dest = node.properties.href as RelativeURL
- node.properties.className ??= []
- node.properties.className.push(isAbsoluteUrl(dest) ? "external" : "internal")
+ const classes = (node.properties.className ?? []) as string[]
+ classes.push(isAbsoluteUrl(dest) ? "external" : "internal")
+
+ // Check if the link has alias text
+ if (
+ node.children.length === 1 &&
+ node.children[0].type === "text" &&
+ node.children[0].value !== dest
+ ) {
+ // Add the 'alias' class if the text content is not the same as the href
+ classes.push("alias")
+ }
+ node.properties.className = classes
+
+ if (opts.openLinksInNewTab) {
+ node.properties.target = "_blank"
+ }
// don't process external links or intra-document anchors
- if (!(isAbsoluteUrl(dest) || dest.startsWith("#"))) {
- dest = node.properties.href = transformLink(curSlug, dest, transformOptions)
- const canonicalDest = path.posix.normalize(joinSegments(curSlug, dest))
- const [destCanonical, _destAnchor] = splitAnchor(canonicalDest)
- outgoing.add(destCanonical as CanonicalSlug)
+ const isInternal = !(isAbsoluteUrl(dest) || dest.startsWith("#"))
+ if (isInternal) {
+ dest = node.properties.href = transformLink(
+ file.data.slug!,
+ dest,
+ transformOptions,
+ )
+
+ // url.resolve is considered legacy
+ // WHATWG equivalent https://nodejs.dev/en/api/v18/url/#urlresolvefrom-to
+ const url = new URL(dest, `https://base.com/${curSlug}`)
+ const canonicalDest = url.pathname
+ let [destCanonical, _destAnchor] = splitAnchor(canonicalDest)
+ if (destCanonical.endsWith("/")) {
+ destCanonical += "index"
+ }
+
+ // need to decodeURIComponent here as WHATWG URL percent-encodes everything
+ const full = decodeURIComponent(_stripSlashes(destCanonical, true)) as FullSlug
+ const simple = simplifySlug(full)
+ outgoing.add(simple)
+ node.properties["data-slug"] = full
}
// rewrite link internals if prettylinks is on
if (
opts.prettyLinks &&
+ isInternal &&
node.children.length === 1 &&
node.children[0].type === "text" &&
!node.children[0].value.startsWith("#")
@@ -77,9 +115,17 @@
node.properties &&
typeof node.properties.src === "string"
) {
+ if (opts.lazyLoad) {
+ node.properties.loading = "lazy"
+ }
+
if (!isAbsoluteUrl(node.properties.src)) {
let dest = node.properties.src as RelativeURL
- dest = node.properties.src = transformLink(curSlug, dest, transformOptions)
+ dest = node.properties.src = transformLink(
+ file.data.slug!,
+ dest,
+ transformOptions,
+ )
node.properties.src = dest
}
}
@@ -95,6 +141,6 @@
declare module "vfile" {
interface DataMap {
- links: CanonicalSlug[]
+ links: SimpleSlug[]
}
}
--
Gitblit v1.10.0