From ef72f1bf707dca363cdab84da91e2acfaef8f276 Mon Sep 17 00:00:00 2001
From: Ammar Alakkad <am.alakkad@gmail.com>
Date: Mon, 30 Dec 2024 16:03:57 +0000
Subject: [PATCH] Fix ObsidianFlavoredMarkdown source link (#1694)
---
quartz/plugins/transformers/ofm.ts | 391 ++++++++++++++++++++++++++++++++++++++++++++++---------
1 files changed, 322 insertions(+), 69 deletions(-)
diff --git a/quartz/plugins/transformers/ofm.ts b/quartz/plugins/transformers/ofm.ts
index d58eaf6..94cc7b6 100644
--- a/quartz/plugins/transformers/ofm.ts
+++ b/quartz/plugins/transformers/ofm.ts
@@ -2,13 +2,18 @@
import { Root, Html, BlockContent, DefinitionContent, Paragraph, Code } from "mdast"
import { Element, Literal, Root as HtmlRoot } from "hast"
import { ReplaceFunction, findAndReplace as mdastFindReplace } from "mdast-util-find-and-replace"
-import { slug as slugAnchor } from "github-slugger"
import rehypeRaw from "rehype-raw"
import { SKIP, visit } from "unist-util-visit"
import path from "path"
-import { JSResource } from "../../util/resources"
+import { splitAnchor } from "../../util/path"
+import { JSResource, CSSResource } from "../../util/resources"
// @ts-ignore
import calloutScript from "../../components/scripts/callout.inline.ts"
+// @ts-ignore
+import checkboxScript from "../../components/scripts/checkbox.inline.ts"
+// @ts-ignore
+import mermaidExtensionScript from "../../components/scripts/mermaid.inline.ts"
+import mermaidStyle from "../../components/styles/mermaid.inline.scss"
import { FilePath, pathToRoot, slugTag, slugifyFilePath } from "../../util/path"
import { toHast } from "mdast-util-to-hast"
import { toHtml } from "hast-util-to-html"
@@ -28,6 +33,7 @@
enableInHtmlEmbed: boolean
enableYouTubeEmbed: boolean
enableVideoEmbed: boolean
+ enableCheckbox: boolean
}
const defaultOptions: Options = {
@@ -42,6 +48,7 @@
enableInHtmlEmbed: false,
enableYouTubeEmbed: true,
enableVideoEmbed: true,
+ enableCheckbox: false,
}
const calloutMapping = {
@@ -74,6 +81,17 @@
cite: "quote",
} as const
+const arrowMapping: Record<string, string> = {
+ "->": "→",
+ "-->": "⇒",
+ "=>": "⇒",
+ "==>": "⇒",
+ "<-": "←",
+ "<--": "⇐",
+ "<=": "⇐",
+ "<==": "⇐",
+}
+
function canonicalizeCallout(calloutName: string): keyof typeof calloutMapping {
const normalizedCallout = calloutName.toLowerCase() as keyof typeof calloutMapping
// if callout is not recognized, make it a custom one
@@ -82,37 +100,46 @@
export const externalLinkRegex = /^https?:\/\//i
-export const arrowRegex = new RegExp(/-{1,2}>/, "g")
+export const arrowRegex = new RegExp(/(-{1,2}>|={1,2}>|<-{1,2}|<={1,2})/g)
-// !? -> optional embedding
-// \[\[ -> open brace
-// ([^\[\]\|\#]+) -> one or more non-special characters ([,],|, or #) (name)
-// (#[^\[\]\|\#]+)? -> # then one or more non-special characters (heading link)
-// (\|[^\[\]\#]+)? -> | then one or more non-special characters (alias)
+// !? -> optional embedding
+// \[\[ -> open brace
+// ([^\[\]\|\#]+) -> one or more non-special characters ([,],|, or #) (name)
+// (#[^\[\]\|\#]+)? -> # then one or more non-special characters (heading link)
+// (\\?\|[^\[\]\#]+)? -> optional escape \ then | then one or more non-special characters (alias)
export const wikilinkRegex = new RegExp(
- /!?\[\[([^\[\]\|\#]+)?(#+[^\[\]\|\#]+)?(\|[^\[\]\#]+)?\]\]/,
- "g",
+ /!?\[\[([^\[\]\|\#\\]+)?(#+[^\[\]\|\#\\]+)?(\\?\|[^\[\]\#]+)?\]\]/g,
)
-const highlightRegex = new RegExp(/==([^=]+)==/, "g")
-const commentRegex = new RegExp(/%%[\s\S]*?%%/, "g")
+
+// ^\|([^\n])+\|\n(\|) -> matches the header row
+// ( ?:?-{3,}:? ?\|)+ -> matches the header row separator
+// (\|([^\n])+\|\n)+ -> matches the body rows
+export const tableRegex = new RegExp(/^\|([^\n])+\|\n(\|)( ?:?-{3,}:? ?\|)+\n(\|([^\n])+\|\n?)+/gm)
+
+// matches any wikilink, only used for escaping wikilinks inside tables
+export const tableWikilinkRegex = new RegExp(/(!?\[\[[^\]]*?\]\]|\[\^[^\]]*?\])/g)
+
+const highlightRegex = new RegExp(/==([^=]+)==/g)
+const commentRegex = new RegExp(/%%[\s\S]*?%%/g)
// from https://github.com/escwxyz/remark-obsidian-callout/blob/main/src/index.ts
-const calloutRegex = new RegExp(/^\[\!(\w+)\]([+-]?)/)
-const calloutLineRegex = new RegExp(/^> *\[\!\w+\][+-]?.*$/, "gm")
+const calloutRegex = new RegExp(/^\[\!([\w-]+)\|?(.+?)?\]([+-]?)/)
+const calloutLineRegex = new RegExp(/^> *\[\!\w+\|?.*?\][+-]?.*$/gm)
// (?:^| ) -> non-capturing group, tag should start be separated by a space or be the start of the line
// #(...) -> capturing group, tag itself must start with #
// (?:[-_\p{L}\d\p{Z}])+ -> non-capturing group, non-empty string of (Unicode-aware) alpha-numeric characters and symbols, hyphens and/or underscores
// (?:\/[-_\p{L}\d\p{Z}]+)*) -> non-capturing group, matches an arbitrary number of tag strings separated by "/"
-const tagRegex = new RegExp(/(?:^| )#((?:[-_\p{L}\p{Emoji}\d])+(?:\/[-_\p{L}\p{Emoji}\d]+)*)/, "gu")
-const blockReferenceRegex = new RegExp(/\^([-_A-Za-z0-9]+)$/, "g")
+const tagRegex = new RegExp(
+ /(?:^| )#((?:[-_\p{L}\p{Emoji}\p{M}\d])+(?:\/[-_\p{L}\p{Emoji}\p{M}\d]+)*)/gu,
+)
+const blockReferenceRegex = new RegExp(/\^([-_A-Za-z0-9]+)$/g)
const ytLinkRegex = /^.*(youtu.be\/|v\/|u\/\w\/|embed\/|watch\?v=|\&v=)([^#\&\?]*).*/
+const ytPlaylistLinkRegex = /[?&]list=([^#?&]*)/
const videoExtensionRegex = new RegExp(/\.(mp4|webm|ogg|avi|mov|flv|wmv|mkv|mpg|mpeg|3gp|m4v)$/)
const wikilinkImageEmbedRegex = new RegExp(
/^(?<alt>(?!^\d*x?\d*$).*?)?(\|?\s*?(?<width>\d+)(x(?<height>\d+))?)?$/,
)
-export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin<Partial<Options> | undefined> = (
- userOpts,
-) => {
+export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin<Partial<Options>> = (userOpts) => {
const opts = { ...defaultOptions, ...userOpts }
const mdastToHtml = (ast: PhrasingContent | Paragraph) => {
@@ -129,7 +156,7 @@
src = src.toString()
}
- src = src.replace(commentRegex, "")
+ src = (src as string).replace(commentRegex, "")
}
// pre-transform blockquotes
@@ -138,7 +165,7 @@
src = src.toString()
}
- src = src.replace(calloutLineRegex, (value) => {
+ src = (src as string).replace(calloutLineRegex, (value) => {
// force newline after title of callout
return value + "\n> "
})
@@ -150,13 +177,27 @@
src = src.toString()
}
- src = src.replace(wikilinkRegex, (value, ...capture) => {
+ // replace all wikilinks inside a table first
+ src = (src as string).replace(tableRegex, (value) => {
+ // escape all aliases and headers in wikilinks inside a table
+ return value.replace(tableWikilinkRegex, (_value, raw) => {
+ // const [raw]: (string | undefined)[] = capture
+ let escaped = raw ?? ""
+ escaped = escaped.replace("#", "\\#")
+ // escape pipe characters if they are not already escaped
+ escaped = escaped.replace(/((^|[^\\])(\\\\)*)\|/g, "$1\\|")
+
+ return escaped
+ })
+ })
+
+ // replace all other wikilinks
+ src = (src as string).replace(wikilinkRegex, (value, ...capture) => {
const [rawFp, rawHeader, rawAlias]: (string | undefined)[] = capture
- const fp = rawFp ?? ""
- const anchor = rawHeader?.trim().replace(/^#+/, "")
- const blockRef = Boolean(anchor?.startsWith("^")) ? "^" : ""
- const displayAnchor = anchor ? `#${blockRef}${slugAnchor(anchor)}` : ""
+ const [fp, anchor] = splitAnchor(`${rawFp ?? ""}${rawHeader ?? ""}`)
+ const blockRef = Boolean(rawHeader?.match(/^#?\^/)) ? "^" : ""
+ const displayAnchor = anchor ? `#${blockRef}${anchor.trim().replace(/^#+/, "")}` : ""
const displayAlias = rawAlias ?? rawHeader?.replace("#", "|") ?? ""
const embedDisplay = value.startsWith("!") ? "!" : ""
@@ -170,7 +211,7 @@
return src
},
- markdownPlugins() {
+ markdownPlugins(_ctx) {
const plugins: PluggableList = []
// regex replacements
@@ -223,14 +264,14 @@
} else if ([".pdf"].includes(ext)) {
return {
type: "html",
- value: `<iframe src="${url}"></iframe>`,
+ value: `<iframe src="${url}" class="pdf"></iframe>`,
}
} else {
const block = anchor
return {
type: "html",
data: { hProperties: { transclude: true } },
- value: `<blockquote class="transclude" data-url="${url}" data-block="${block}"><a href="${
+ value: `<blockquote class="transclude" data-url="${url}" data-block="${block}" data-embed-alias="${alias}"><a href="${
url + anchor
}" class="transclude-inner">Transclude of ${url}${block}</a></blockquote>`,
}
@@ -241,6 +282,7 @@
// internal link
const url = fp + anchor
+
return {
type: "link",
url,
@@ -271,10 +313,12 @@
if (opts.parseArrows) {
replacements.push([
arrowRegex,
- (_value: string, ..._capture: string[]) => {
+ (value: string, ..._capture: string[]) => {
+ const maybeArrow = arrowMapping[value]
+ if (maybeArrow === undefined) return SKIP
return {
type: "html",
- value: `<span>→</span>`,
+ value: `<span>${maybeArrow}</span>`,
}
},
])
@@ -284,8 +328,8 @@
replacements.push([
tagRegex,
(_value: string, tag: string) => {
- // Check if the tag only includes numbers
- if (/^\d+$/.test(tag)) {
+ // Check if the tag only includes numbers and slashes
+ if (/^[\/\d]+$/.test(tag)) {
return false
}
@@ -306,7 +350,7 @@
children: [
{
type: "text",
- value: `#${tag}`,
+ value: tag,
},
],
}
@@ -366,8 +410,8 @@
return
}
- // find first line
- const firstChild = node.children[0]
+ // find first line and callout content
+ const [firstChild, ...calloutContent] = node.children
if (firstChild.type !== "paragraph" || firstChild.children[0]?.type !== "text") {
return
}
@@ -379,18 +423,23 @@
const match = firstLine.match(calloutRegex)
if (match && match.input) {
- const [calloutDirective, typeString, collapseChar] = match
+ const [calloutDirective, typeString, calloutMetaData, collapseChar] = match
const calloutType = canonicalizeCallout(typeString.toLowerCase())
const collapse = collapseChar === "+" || collapseChar === "-"
const defaultState = collapseChar === "-" ? "collapsed" : "expanded"
- const titleContent =
- match.input.slice(calloutDirective.length).trim() || capitalize(calloutType)
+ const titleContent = match.input.slice(calloutDirective.length).trim()
+ const useDefaultTitle = titleContent === "" && restOfTitle.length === 0
const titleNode: Paragraph = {
type: "paragraph",
- children:
- restOfTitle.length === 0
- ? [{ type: "text", value: titleContent + " " }]
- : restOfTitle,
+ children: [
+ {
+ type: "text",
+ value: useDefaultTitle
+ ? capitalize(typeString).replace(/-/g, " ")
+ : titleContent + " ",
+ },
+ ...restOfTitle,
+ ],
}
const title = mdastToHtml(titleNode)
@@ -423,17 +472,39 @@
// replace first line of blockquote with title and rest of the paragraph text
node.children.splice(0, 1, ...blockquoteContent)
+ const classNames = ["callout", calloutType]
+ if (collapse) {
+ classNames.push("is-collapsible")
+ }
+ if (defaultState === "collapsed") {
+ classNames.push("is-collapsed")
+ }
+
// add properties to base blockquote
node.data = {
hProperties: {
...(node.data?.hProperties ?? {}),
- className: `callout ${calloutType} ${collapse ? "is-collapsible" : ""} ${
- defaultState === "collapsed" ? "is-collapsed" : ""
- }`,
+ className: classNames.join(" "),
"data-callout": calloutType,
"data-callout-fold": collapse,
+ "data-callout-metadata": calloutMetaData,
},
}
+
+ // Add callout-content class to callout body if it has one.
+ if (calloutContent.length > 0) {
+ const contentData: BlockContent | DefinitionContent = {
+ data: {
+ hProperties: {
+ className: "callout-content",
+ },
+ hName: "div",
+ },
+ type: "blockquote",
+ children: [...calloutContent],
+ }
+ node.children = [node.children[0], contentData]
+ }
}
})
}
@@ -448,6 +519,7 @@
node.data = {
hProperties: {
className: ["mermaid"],
+ "data-clipboard": JSON.stringify(node.value),
},
}
}
@@ -497,12 +569,35 @@
last.value = last.value.slice(0, -matches[0].length)
const block = matches[0].slice(1)
- if (!Object.keys(file.data.blocks!).includes(block)) {
- node.properties = {
- ...node.properties,
- id: block,
+ if (last.value === "") {
+ // this is an inline block ref but the actual block
+ // is the previous element above it
+ let idx = (index ?? 1) - 1
+ while (idx >= 0) {
+ const element = parent?.children.at(idx)
+ if (!element) break
+ if (element.type !== "element") {
+ idx -= 1
+ } else {
+ if (!Object.keys(file.data.blocks!).includes(block)) {
+ element.properties = {
+ ...element.properties,
+ id: block,
+ }
+ file.data.blocks![block] = element
+ }
+ return
+ }
}
- file.data.blocks![block] = node
+ } else {
+ // normal paragraph transclude
+ if (!Object.keys(file.data.blocks!).includes(block)) {
+ node.properties = {
+ ...node.properties,
+ id: block,
+ }
+ file.data.blocks![block] = node
+ }
}
}
}
@@ -521,15 +616,28 @@
if (node.tagName === "img" && typeof node.properties.src === "string") {
const match = node.properties.src.match(ytLinkRegex)
const videoId = match && match[2].length == 11 ? match[2] : null
+ const playlistId = node.properties.src.match(ytPlaylistLinkRegex)?.[1]
if (videoId) {
+ // YouTube video (with optional playlist)
node.tagName = "iframe"
node.properties = {
- class: "external-embed",
+ class: "external-embed youtube",
allow: "fullscreen",
frameborder: 0,
width: "600px",
- height: "350px",
- src: `https://www.youtube.com/embed/${videoId}`,
+ src: playlistId
+ ? `https://www.youtube.com/embed/${videoId}?list=${playlistId}`
+ : `https://www.youtube.com/embed/${videoId}`,
+ }
+ } else if (playlistId) {
+ // YouTube playlist only.
+ node.tagName = "iframe"
+ node.properties = {
+ class: "external-embed youtube",
+ allow: "fullscreen",
+ frameborder: 0,
+ width: "600px",
+ src: `https://www.youtube.com/embed/videoseries?list=${playlistId}`,
}
}
}
@@ -538,10 +646,164 @@
})
}
+ if (opts.enableCheckbox) {
+ plugins.push(() => {
+ return (tree: HtmlRoot, _file) => {
+ visit(tree, "element", (node) => {
+ if (node.tagName === "input" && node.properties.type === "checkbox") {
+ const isChecked = node.properties?.checked ?? false
+ node.properties = {
+ type: "checkbox",
+ disabled: false,
+ checked: isChecked,
+ class: "checkbox-toggle",
+ }
+ }
+ })
+ }
+ })
+ }
+
+ if (opts.mermaid) {
+ plugins.push(() => {
+ return (tree: HtmlRoot, _file) => {
+ visit(tree, "element", (node: Element, _idx, parent) => {
+ if (
+ node.tagName === "code" &&
+ ((node.properties?.className ?? []) as string[])?.includes("mermaid")
+ ) {
+ parent!.children = [
+ {
+ type: "element",
+ tagName: "button",
+ properties: {
+ className: ["expand-button"],
+ "aria-label": "Expand mermaid diagram",
+ "aria-hidden": "true",
+ "data-view-component": true,
+ },
+ children: [
+ {
+ type: "element",
+ tagName: "svg",
+ properties: {
+ width: 16,
+ height: 16,
+ viewBox: "0 0 16 16",
+ fill: "currentColor",
+ },
+ children: [
+ {
+ type: "element",
+ tagName: "path",
+ properties: {
+ fillRule: "evenodd",
+ d: "M3.72 3.72a.75.75 0 011.06 1.06L2.56 7h10.88l-2.22-2.22a.75.75 0 011.06-1.06l3.5 3.5a.75.75 0 010 1.06l-3.5 3.5a.75.75 0 11-1.06-1.06l2.22-2.22H2.56l2.22 2.22a.75.75 0 11-1.06 1.06l-3.5-3.5a.75.75 0 010-1.06l3.5-3.5z",
+ },
+ children: [],
+ },
+ ],
+ },
+ ],
+ },
+ node,
+ {
+ type: "element",
+ tagName: "div",
+ properties: { id: "mermaid-container" },
+ children: [
+ {
+ type: "element",
+ tagName: "div",
+ properties: { id: "mermaid-space" },
+ children: [
+ {
+ type: "element",
+ tagName: "div",
+ properties: { className: ["mermaid-header"] },
+ children: [
+ {
+ type: "element",
+ tagName: "button",
+ properties: {
+ className: ["close-button"],
+ "aria-label": "close button",
+ },
+ children: [
+ {
+ type: "element",
+ tagName: "svg",
+ properties: {
+ "aria-hidden": "true",
+ xmlns: "http://www.w3.org/2000/svg",
+ width: 24,
+ height: 24,
+ viewBox: "0 0 24 24",
+ fill: "none",
+ stroke: "currentColor",
+ "stroke-width": "2",
+ "stroke-linecap": "round",
+ "stroke-linejoin": "round",
+ },
+ children: [
+ {
+ type: "element",
+ tagName: "line",
+ properties: {
+ x1: 18,
+ y1: 6,
+ x2: 6,
+ y2: 18,
+ },
+ children: [],
+ },
+ {
+ type: "element",
+ tagName: "line",
+ properties: {
+ x1: 6,
+ y1: 6,
+ x2: 18,
+ y2: 18,
+ },
+ children: [],
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ },
+ {
+ type: "element",
+ tagName: "div",
+ properties: { className: ["mermaid-content"] },
+ children: [],
+ },
+ ],
+ },
+ ],
+ },
+ ]
+ }
+ })
+ }
+ })
+ }
+
return plugins
},
externalResources() {
const js: JSResource[] = []
+ const css: CSSResource[] = []
+
+ if (opts.enableCheckbox) {
+ js.push({
+ script: checkboxScript,
+ loadTime: "afterDOMReady",
+ contentType: "inline",
+ })
+ }
if (opts.callouts) {
js.push({
@@ -553,27 +815,18 @@
if (opts.mermaid) {
js.push({
- script: `
- import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.esm.min.mjs';
- const darkMode = document.documentElement.getAttribute('saved-theme') === 'dark'
- mermaid.initialize({
- startOnLoad: false,
- securityLevel: 'loose',
- theme: darkMode ? 'dark' : 'default'
- });
- document.addEventListener('nav', async () => {
- await mermaid.run({
- querySelector: '.mermaid'
- })
- });
- `,
+ script: mermaidExtensionScript,
loadTime: "afterDOMReady",
moduleType: "module",
contentType: "inline",
})
+ css.push({
+ content: mermaidStyle,
+ inline: true,
+ })
}
- return { js }
+ return { js, css }
},
}
}
--
Gitblit v1.10.0