From 6ecdcb5e24f2783e6fa73de69e848f0f319c4fc4 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Wed, 13 Sep 2023 05:55:50 +0000
Subject: [PATCH] feat: resolve block references in obsidian markdown
---
quartz/plugins/transformers/ofm.ts | 87 +++++++++++++++++++++++++++++++------------
1 files changed, 63 insertions(+), 24 deletions(-)
diff --git a/quartz/plugins/transformers/ofm.ts b/quartz/plugins/transformers/ofm.ts
index fc56f3f..b2f1dba 100644
--- a/quartz/plugins/transformers/ofm.ts
+++ b/quartz/plugins/transformers/ofm.ts
@@ -1,15 +1,16 @@
import { PluggableList } from "unified"
import { QuartzTransformerPlugin } from "../types"
import { Root, HTML, BlockContent, DefinitionContent, Code, Paragraph } from "mdast"
+import { Element, Literal } from 'hast'
import { Replace, findAndReplace as mdastFindReplace } from "mdast-util-find-and-replace"
import { slug as slugAnchor } from "github-slugger"
import rehypeRaw from "rehype-raw"
import { visit } from "unist-util-visit"
import path from "path"
-import { JSResource } from "../../resources"
+import { JSResource } from "../../util/resources"
// @ts-ignore
import calloutScript from "../../components/scripts/callout.inline.ts"
-import { FilePath, canonicalizeServer, pathToRoot, slugTag, slugifyFilePath } from "../../path"
+import { FilePath, pathToRoot, slugTag, slugifyFilePath } from "../../util/path"
import { toHast } from "mdast-util-to-hast"
import { toHtml } from "hast-util-to-html"
import { PhrasingContent } from "mdast-util-find-and-replace/lib"
@@ -21,6 +22,7 @@
callouts: boolean
mermaid: boolean
parseTags: boolean
+ parseBlockReferences: boolean
enableInHtmlEmbed: boolean
}
@@ -31,6 +33,7 @@
callouts: true,
mermaid: true,
parseTags: true,
+ parseBlockReferences: true,
enableInHtmlEmbed: false,
}
@@ -69,6 +72,8 @@
const calloutMapping: Record<string, keyof typeof callouts> = {
note: "note",
abstract: "abstract",
+ summary: "abstract",
+ tldr: "abstract",
info: "info",
todo: "todo",
tip: "tip",
@@ -96,7 +101,7 @@
function canonicalizeCallout(calloutName: string): keyof typeof callouts {
let callout = calloutName.toLowerCase() as keyof typeof calloutMapping
- return calloutMapping[callout] ?? calloutName
+ return calloutMapping[callout] ?? "note"
}
const capitalize = (s: string): string => {
@@ -109,14 +114,17 @@
// (#[^\[\]\|\#]+)? -> # then one or more non-special characters (heading link)
// (|[^\[\]\|\#]+)? -> | then one or more non-special characters (alias)
const wikilinkRegex = new RegExp(/!?\[\[([^\[\]\|\#]+)?(#[^\[\]\|\#]+)?(\|[^\[\]\|\#]+)?\]\]/, "g")
-const highlightRegex = new RegExp(/==(.+)==/, "g")
+const highlightRegex = new RegExp(/==([^=]+)==/, "g")
const commentRegex = new RegExp(/%%(.+)%%/, "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")
-// (?:^| ) -> non-capturing group, tag should start be separated by a space or be the start of the line
-// #(\w+) -> tag itself is # followed by a string of alpha-numeric characters
-const tagRegex = new RegExp(/(?:^| )#([\w-_\/]+)/, "g")
+// (?:^| ) -> 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}])+ -> non-capturing group, non-empty string of (Unicode-aware) alpha-numeric characters, hyphens and/or underscores
+// (?:\/[-_\p{L}]+)*) -> non-capturing group, matches an arbitrary number of tag strings separated by "/"
+const tagRegex = new RegExp(/(?:^| )#((?:[-_\p{L}\d])+(?:\/[-_\p{L}\d]+)*)/, "gu")
+const blockReferenceRegex = new RegExp(/\^([A-Za-z0-9]+)$/, "g")
export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin<Partial<Options> | undefined> = (
userOpts,
@@ -196,7 +204,7 @@
// embed cases
if (value.startsWith("!")) {
const ext: string = path.extname(fp).toLowerCase()
- const url = slugifyFilePath(fp as FilePath) + ext
+ const url = slugifyFilePath(fp as FilePath)
if ([".png", ".jpg", ".jpeg", ".gif", ".bmp", ".svg"].includes(ext)) {
const dims = alias ?? ""
let [width, height] = dims.split("x", 2)
@@ -294,7 +302,7 @@
}
const text = firstChild.children[0].value
- const restChildren = firstChild.children.splice(1)
+ const restChildren = firstChild.children.slice(1)
const [firstLine, ...remainingLines] = text.split("\n")
const remainingText = remainingLines.join("\n")
@@ -309,11 +317,8 @@
const titleContent =
match.input.slice(calloutDirective.length).trim() || capitalize(calloutType)
const titleNode: Paragraph = {
- type: 'paragraph',
- children: [
- {type: 'text', value: titleContent + " "},
- ...restChildren
- ]
+ type: "paragraph",
+ children: [{ type: "text", value: titleContent + " " }, ...restChildren],
}
const title = mdastToHtml(titleNode)
@@ -323,7 +328,7 @@
const titleHtml: HTML = {
type: "html",
- value: `<div
+ value: `<div
class="callout-title"
>
<div class="callout-icon">${callouts[calloutType]}</div>
@@ -383,16 +388,16 @@
if (opts.parseTags) {
plugins.push(() => {
return (tree: Root, file) => {
- const slug = canonicalizeServer(file.data.slug!)
- const base = pathToRoot(slug)
- findAndReplace(tree, tagRegex, (value: string, tag: string) => {
- if (file.data.frontmatter) {
+ const base = pathToRoot(file.data.slug!)
+ findAndReplace(tree, tagRegex, (_value: string, tag: string) => {
+ tag = slugTag(tag)
+ if (file.data.frontmatter && !file.data.frontmatter.tags.includes(tag)) {
file.data.frontmatter.tags.push(tag)
}
return {
type: "link",
- url: base + `/tags/${slugTag(tag)}`,
+ url: base + `/tags/${tag}`,
data: {
hProperties: {
className: ["tag-link"],
@@ -401,7 +406,7 @@
children: [
{
type: "text",
- value,
+ value: `#${tag}`,
},
],
}
@@ -409,11 +414,38 @@
}
})
}
-
return plugins
},
htmlPlugins() {
- return [rehypeRaw]
+ const plugins = [rehypeRaw]
+
+ if (opts.parseBlockReferences) {
+ plugins.push(() => {
+ return (tree, file) => {
+ file.data.blocks = {}
+ const validTagTypes = new Set(["blockquote", "p", "li"])
+ visit(tree, "element", (node, _index, _parent) => {
+ if (validTagTypes.has(node.tagName)) {
+ const last = node.children.at(-1) as Literal
+ if (last.value && typeof last.value === 'string') {
+ const matches = last.value.match(blockReferenceRegex)
+ if (matches && matches.length >= 1) {
+ last.value = last.value.slice(0, -matches[0].length)
+ const block = matches[0].slice(1)
+ node.properties = {
+ ...node.properties,
+ id: block
+ }
+ file.data.blocks![block] = node
+ }
+ }
+ }
+ })
+ }
+ })
+ }
+
+ return plugins
},
externalResources() {
const js: JSResource[] = []
@@ -431,7 +463,7 @@
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({
+ mermaid.initialize({
startOnLoad: false,
securityLevel: 'loose',
theme: darkMode ? 'dark' : 'default'
@@ -452,3 +484,10 @@
},
}
}
+
+declare module "vfile" {
+ interface DataMap {
+ blocks: Record<string, Element>
+ }
+}
+
--
Gitblit v1.10.0