From 08f8e3b4a4879dd7c91c16fbce80c4f2bc5e357f Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Mon, 10 Jul 2023 02:32:24 +0000
Subject: [PATCH] docs + various polish
---
quartz/plugins/transformers/links.ts | 75 +++++++++++++++++++++++++++++--------
1 files changed, 58 insertions(+), 17 deletions(-)
diff --git a/quartz/plugins/transformers/links.ts b/quartz/plugins/transformers/links.ts
index 4bf0e08..f45e23f 100644
--- a/quartz/plugins/transformers/links.ts
+++ b/quartz/plugins/transformers/links.ts
@@ -1,41 +1,61 @@
import { QuartzTransformerPlugin } from "../types"
-import { relative, relativeToRoot, slugify } from "../../path"
+import { clientSideSlug, relative, relativeToRoot, slugify, trimPathSuffix } from "../../path"
import path from "path"
import { visit } from 'unist-util-visit'
import isAbsoluteUrl from "is-absolute-url"
interface Options {
/** How to resolve Markdown paths */
- markdownLinkResolution: 'absolute' | 'relative'
+ markdownLinkResolution: 'absolute' | 'relative' | 'shortest'
/** Strips folders from a link so that it looks nice */
prettyLinks: boolean
+ indexAnchorLinks: boolean
+ indexExternalLinks: boolean
}
const defaultOptions: Options = {
markdownLinkResolution: 'absolute',
- prettyLinks: true
+ prettyLinks: true,
+ indexAnchorLinks: false,
+ indexExternalLinks: false,
}
-export const ResolveLinks: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
+export const CrawlLinks: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
const opts = { ...defaultOptions, ...userOpts }
return {
name: "LinkProcessing",
- markdownPlugins() {
- return []
- },
htmlPlugins() {
return [() => {
return (tree, file) => {
- const curSlug = file.data.slug!
+ const curSlug = clientSideSlug(file.data.slug!)
const transformLink = (target: string) => {
- const targetSlug = slugify(decodeURI(target).trim())
+ const targetSlug = clientSideSlug(slugify(decodeURI(target).trim()))
if (opts.markdownLinkResolution === 'relative' && !path.isAbsolute(targetSlug)) {
return './' + relative(curSlug, targetSlug)
- } else {
- return './' + relativeToRoot(curSlug, targetSlug)
+ } else if (opts.markdownLinkResolution === 'shortest') {
+ // https://forum.obsidian.md/t/settings-new-link-format-what-is-shortest-path-when-possible/6748/5
+ const allSlugs = file.data.allSlugs!
+
+ // if the file name is unique, then it's just the filename
+ const matchingFileNames = allSlugs.filter(slug => {
+ const parts = clientSideSlug(slug).split(path.posix.sep)
+ const fileName = parts.at(-1)
+ return targetSlug === fileName
+ })
+
+ if (matchingFileNames.length === 1) {
+ const targetSlug = clientSideSlug(matchingFileNames[0])
+ return './' + relativeToRoot(curSlug, targetSlug)
+ }
+
+ // if it's not unique, then it's the absolute path from the vault root
+ // (fall-through case)
}
+ // treat as absolute
+ return './' + relativeToRoot(curSlug, targetSlug)
}
+ const outgoing: Set<string> = new Set()
visit(tree, 'element', (node, _index, _parent) => {
// rewrite all links
if (
@@ -43,13 +63,26 @@
node.properties &&
typeof node.properties.href === 'string'
) {
- node.properties.className = isAbsoluteUrl(node.properties.href) ? "external" : "internal"
+ let dest = node.properties.href
+ node.properties.className = isAbsoluteUrl(dest) ? "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)
- } else {
+ if (!(isAbsoluteUrl(dest) || dest.startsWith("#"))) {
+ node.properties.href = transformLink(dest)
+ }
+ dest = node.properties.href
+ if (dest.startsWith(".")) {
+ const normalizedPath = path.normalize(path.join(curSlug, dest))
+ outgoing.add(trimPathSuffix(normalizedPath))
+ } else if (dest.startsWith("#")) {
+ if (opts.indexAnchorLinks) {
+ outgoing.add(dest)
+ }
+ } else {
+ if (opts.indexExternalLinks) {
+ outgoing.add(dest)
+ }
}
// rewrite link internals if prettylinks is on
@@ -58,9 +91,9 @@
}
}
- // transform all images
+ // transform all other resources that may use links
if (
- node.tagName === 'img' &&
+ ["img", "video", "audio", "iframe"].includes(node.tagName) &&
node.properties &&
typeof node.properties.src === 'string'
) {
@@ -70,8 +103,16 @@
}
}
})
+
+ file.data.links = [...outgoing]
}
}]
}
}
}
+
+declare module 'vfile' {
+ interface DataMap {
+ links: string[]
+ }
+}
--
Gitblit v1.10.0