From c538c151c7462ad0395ff2c15c5e11e89e362aa8 Mon Sep 17 00:00:00 2001
From: Striven <sg.striven@cutecat.club>
Date: Sat, 04 Apr 2026 19:47:16 +0000
Subject: [PATCH] Initial commit
---
quartz/plugins/transformers/links.ts | 152 ++++++++++++++++++++++++++++++++++----------------
1 files changed, 103 insertions(+), 49 deletions(-)
diff --git a/quartz/plugins/transformers/links.ts b/quartz/plugins/transformers/links.ts
index 0765062..f4451d9 100644
--- a/quartz/plugins/transformers/links.ts
+++ b/quartz/plugins/transformers/links.ts
@@ -1,67 +1,53 @@
import { QuartzTransformerPlugin } from "../types"
import {
- CanonicalSlug,
+ FullSlug,
RelativeURL,
- canonicalizeServer,
- joinSegments,
- pathToRoot,
- resolveRelative,
+ SimpleSlug,
+ TransformOptions,
+ stripSlashes,
+ simplifySlug,
splitAnchor,
- transformInternalLink,
-} from "../../path"
+ 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: "absolute" | "relative" | "shortest"
+ markdownLinkResolution: TransformOptions["strategy"]
/** Strips folders from a link so that it looks nice */
prettyLinks: boolean
+ openLinksInNewTab: boolean
+ lazyLoad: boolean
+ externalLinkIcon: boolean
}
const defaultOptions: Options = {
markdownLinkResolution: "absolute",
prettyLinks: true,
+ openLinksInNewTab: false,
+ lazyLoad: false,
+ externalLinkIcon: true,
}
-export const CrawlLinks: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
+export const CrawlLinks: QuartzTransformerPlugin<Partial<Options>> = (userOpts) => {
const opts = { ...defaultOptions, ...userOpts }
return {
name: "LinkProcessing",
htmlPlugins(ctx) {
return [
() => {
- return (tree, file) => {
- const curSlug = canonicalizeServer(file.data.slug!)
- const transformLink = (target: string): RelativeURL => {
- const targetSlug = transformInternalLink(target).slice("./".length)
- let [targetCanonical, targetAnchor] = splitAnchor(targetSlug)
- if (opts.markdownLinkResolution === "relative") {
- return targetSlug as RelativeURL
- } else if (opts.markdownLinkResolution === "shortest") {
- // if the file name is unique, then it's just the filename
- const matchingFileNames = ctx.allSlugs.filter((slug) => {
- const parts = slug.split(path.posix.sep)
- const fileName = parts.at(-1)
- return targetCanonical === fileName
- })
+ return (tree: Root, file) => {
+ const curSlug = simplifySlug(file.data.slug!)
+ const outgoing: Set<SimpleSlug> = new Set()
- // only match, just use it
- if (matchingFileNames.length === 1) {
- const targetSlug = canonicalizeServer(matchingFileNames[0])
- return (resolveRelative(curSlug, targetSlug) + targetAnchor) as RelativeURL
- }
-
- // if it's not unique, then it's the absolute path from the vault root
- // (fall-through case)
- }
-
- // treat as absolute
- return joinSegments(pathToRoot(curSlug), targetSlug) as RelativeURL
+ const transformOptions: TransformOptions = {
+ strategy: opts.markdownLinkResolution,
+ allSlugs: ctx.allSlugs,
}
- const outgoing: Set<CanonicalSlug> = new Set()
visit(tree, "element", (node, _index, _parent) => {
// rewrite all links
if (
@@ -70,22 +56,82 @@
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[]
+ const isExternal = isAbsoluteUrl(dest, { httpOnly: false })
+ classes.push(isExternal ? "external" : "internal")
+
+ if (isExternal && opts.externalLinkIcon) {
+ node.children.push({
+ type: "element",
+ tagName: "svg",
+ properties: {
+ "aria-hidden": "true",
+ class: "external-icon",
+ style: "max-width:0.8em;max-height:0.8em",
+ viewBox: "0 0 512 512",
+ },
+ children: [
+ {
+ type: "element",
+ tagName: "path",
+ properties: {
+ d: "M320 0H288V64h32 82.7L201.4 265.4 178.7 288 224 333.3l22.6-22.6L448 109.3V192v32h64V192 32 0H480 320zM32 32H0V64 480v32H32 456h32V480 352 320H424v32 96H64V96h96 32V32H160 32z",
+ },
+ children: [],
+ },
+ ],
+ })
+ }
+
+ // 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 (isExternal && 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(dest)
- const canonicalDest = path.posix.normalize(joinSegments(curSlug, dest))
- const [destCanonical, _destAnchor] = splitAnchor(canonicalDest)
- outgoing.add(destCanonical as CanonicalSlug)
+ const isInternal = !(
+ isAbsoluteUrl(dest, { httpOnly: false }) || 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/" + stripSlashes(curSlug, true))
+ 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].type === "text" &&
+ !node.children[0].value.startsWith("#")
) {
node.children[0].value = path.basename(node.children[0].value)
}
@@ -97,10 +143,18 @@
node.properties &&
typeof node.properties.src === "string"
) {
- if (!isAbsoluteUrl(node.properties.src)) {
- const ext = path.extname(node.properties.src)
- node.properties.src =
- transformLink(joinSegments("assets", node.properties.src)) + ext
+ if (opts.lazyLoad) {
+ node.properties.loading = "lazy"
+ }
+
+ if (!isAbsoluteUrl(node.properties.src, { httpOnly: false })) {
+ let dest = node.properties.src as RelativeURL
+ dest = node.properties.src = transformLink(
+ file.data.slug!,
+ dest,
+ transformOptions,
+ )
+ node.properties.src = dest
}
}
})
@@ -115,6 +169,6 @@
declare module "vfile" {
interface DataMap {
- links: CanonicalSlug[]
+ links: SimpleSlug[]
}
}
--
Gitblit v1.10.0