quartz-research-note/quartz/plugins/transformers/links.ts

82 lines
2.6 KiB
TypeScript
Raw Normal View History

import { PluggableList } from "unified"
import { QuartzTransformerPlugin } from "../types"
import { relative, relativeToRoot, slugify } 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'
/** Strips folders from a link so that it looks nice */
prettyLinks: boolean
}
const defaultOptions: Options = {
markdownLinkResolution: 'absolute',
prettyLinks: true
}
2023-06-01 16:33:20 +00:00
export class ResolveLinks extends QuartzTransformerPlugin {
name = "LinkProcessing"
opts: Options
constructor(opts?: Options) {
super()
this.opts = { ...defaultOptions, ...opts }
}
markdownPlugins(): PluggableList {
2023-06-01 16:33:20 +00:00
return []
}
htmlPlugins(): PluggableList {
return [() => {
return (tree, file) => {
2023-05-31 21:41:44 +00:00
const curSlug = file.data.slug!
const transformLink = (target: string) => {
2023-05-31 21:41:44 +00:00
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) => {
2023-05-31 21:41:44 +00:00
// 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)
}
2023-05-31 21:41:44 +00:00
// 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)
}
}
2023-05-31 21:41:44 +00:00
// 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)
2023-05-31 21:41:44 +00:00
node.properties.src = transformLink(path.join("assets", node.properties.src)) + ext
}
}
})
}
}]
}
}