From e47c29d2fd4eae06c511c914e2a5fcb057b44d7b Mon Sep 17 00:00:00 2001
From: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date: Mon, 19 Aug 2024 21:14:29 +0000
Subject: [PATCH] chore(deps): bump rehype-katex from 7.0.0 to 7.0.1 (#1356)
---
quartz/plugins/transformers/links.ts | 219 ++++++++++++++++++++++++++++++++++++++----------------
1 files changed, 153 insertions(+), 66 deletions(-)
diff --git a/quartz/plugins/transformers/links.ts b/quartz/plugins/transformers/links.ts
index 04b26c6..38bc0dc 100644
--- a/quartz/plugins/transformers/links.ts
+++ b/quartz/plugins/transformers/links.ts
@@ -1,84 +1,171 @@
-import { PluggableList } from "unified"
import { QuartzTransformerPlugin } from "../types"
-import { remarkWikiLink } from "@flowershow/remark-wiki-link"
-import { relative, relativeToRoot, slugify } from "../../path"
+import {
+ FullSlug,
+ RelativeURL,
+ SimpleSlug,
+ TransformOptions,
+ stripSlashes,
+ simplifySlug,
+ splitAnchor,
+ transformLink,
+} from "../../util/path"
import path from "path"
-import { visit } from 'unist-util-visit'
+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'
+ 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
+ markdownLinkResolution: "absolute",
+ prettyLinks: true,
+ openLinksInNewTab: false,
+ lazyLoad: false,
+ externalLinkIcon: true,
}
-export class LinkProcessing extends QuartzTransformerPlugin {
- name = "LinkProcessing"
- opts: Options
+export const CrawlLinks: QuartzTransformerPlugin<Partial<Options>> = (userOpts) => {
+ const opts = { ...defaultOptions, ...userOpts }
+ return {
+ name: "LinkProcessing",
+ htmlPlugins(ctx) {
+ return [
+ () => {
+ return (tree: Root, file) => {
+ const curSlug = simplifySlug(file.data.slug!)
+ const outgoing: Set<SimpleSlug> = new Set()
- constructor(opts?: Options) {
- super()
- this.opts = { ...defaultOptions, ...opts }
+ const transformOptions: TransformOptions = {
+ strategy: opts.markdownLinkResolution,
+ allSlugs: ctx.allSlugs,
+ }
+
+ visit(tree, "element", (node, _index, _parent) => {
+ // rewrite all links
+ if (
+ node.tagName === "a" &&
+ node.properties &&
+ typeof node.properties.href === "string"
+ ) {
+ let dest = node.properties.href as RelativeURL
+ const classes = (node.properties.className ?? []) as string[]
+ const isExternal = isAbsoluteUrl(dest)
+ classes.push(isExternal ? "external" : "internal")
+
+ if (isExternal && opts.externalLinkIcon) {
+ node.children.push({
+ type: "element",
+ tagName: "svg",
+ properties: {
+ "aria-hidden": "true",
+ class: "external-icon",
+ 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
+ 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/" + 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].value.startsWith("#")
+ ) {
+ node.children[0].value = path.basename(node.children[0].value)
+ }
+ }
+
+ // transform all other resources that may use links
+ if (
+ ["img", "video", "audio", "iframe"].includes(node.tagName) &&
+ 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(
+ file.data.slug!,
+ dest,
+ transformOptions,
+ )
+ node.properties.src = dest
+ }
+ }
+ })
+
+ file.data.links = [...outgoing]
+ }
+ },
+ ]
+ },
}
+}
- markdownPlugins(): PluggableList {
- return [[remarkWikiLink, {
- pathFormat: this.opts.markdownLinkResolution === "absolute" ? 'obsidian-absolute' : 'raw',
- }]]
- }
-
- htmlPlugins(): PluggableList {
- return [() => {
- return (tree, file) => {
- const curSlug = file.data.slug!
- const transformLink = (target: string) => {
- const targetSlug = slugify(decodeURI(target).trim())
- if (this.opts.markdownLinkResolution === 'relative' && !path.isAbsolute(targetSlug)) {
- return './' + relative(curSlug, targetSlug)
- } else {
- return './' + relativeToRoot(curSlug, targetSlug)
- }
- }
-
- visit(tree, 'element', (node, _index, _parent) => {
- // rewrite all links
- if (
- node.tagName === 'a' &&
- node.properties &&
- typeof node.properties.href === 'string'
- ) {
- node.properties.className = isAbsoluteUrl(node.properties.href) ? "external" : "internal"
-
- // don't process external links or intra-document anchors
- if (!(isAbsoluteUrl(node.properties.href) || node.properties.href.startsWith("#"))) {
- node.properties.href = transformLink(node.properties.href)
- }
-
- // rewrite link internals if prettylinks is on
- if (this.opts.prettyLinks && node.children.length === 1 && node.children[0].type === 'text') {
- node.children[0].value = path.basename(node.children[0].value)
- }
- }
-
- // transform all images
- if (
- node.tagName === 'img' &&
- node.properties &&
- typeof node.properties.src === 'string'
- ) {
- if (!isAbsoluteUrl(node.properties.src)) {
- const ext = path.extname(node.properties.src)
- node.properties.src = transformLink(path.join("assets", node.properties.src)) + ext
- }
- }
- })
- }
- }]
+declare module "vfile" {
+ interface DataMap {
+ links: SimpleSlug[]
}
}
--
Gitblit v1.10.0