From 3ac6b42e16dca5a44ed3fec2c0314f1dbbc2322b Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Sun, 16 Jul 2023 06:02:12 +0000
Subject: [PATCH] finish path refactoring, add sourcemap + better trace support
---
quartz/plugins/transformers/ofm.ts | 116 +++++++++++++++++++++++++++++++++++++++++++--------------
1 files changed, 87 insertions(+), 29 deletions(-)
diff --git a/quartz/plugins/transformers/ofm.ts b/quartz/plugins/transformers/ofm.ts
index aa83953..a7f8f59 100644
--- a/quartz/plugins/transformers/ofm.ts
+++ b/quartz/plugins/transformers/ofm.ts
@@ -2,13 +2,17 @@
import { QuartzTransformerPlugin } from "../types"
import { Root, HTML, BlockContent, DefinitionContent, Code } from 'mdast'
import { findAndReplace } from "mdast-util-find-and-replace"
-import { slugify } from "../../path"
+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"
+// @ts-ignore
+import calloutScript from "../../components/scripts/callout.inline.ts"
+import { FilePath, slugifyFilePath, transformInternalLink } from "../../path"
export interface Options {
+ comments: boolean
highlight: boolean
wikilinks: boolean
callouts: boolean
@@ -16,10 +20,11 @@
}
const defaultOptions: Options = {
+ comments: true,
highlight: true,
wikilinks: true,
callouts: true,
- mermaid: false,
+ mermaid: true,
}
const icons = {
@@ -92,31 +97,57 @@
return s.substring(0, 1).toUpperCase() + s.substring(1);
}
+// Match wikilinks
+// !? -> 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)
+const wikilinkRegex = new RegExp(/!?\[\[([^\[\]\|\#]+)(#[^\[\]\|\#]+)?(\|[^\[\]\|\#]+)?\]\]/, "g")
+
+// Match highlights
+const highlightRegex = new RegExp(/==(.+)==/, "g")
+
+// Match comments
+const commentRegex = new RegExp(/%%(.+)%%/, "g")
+
+// from https://github.com/escwxyz/remark-obsidian-callout/blob/main/src/index.ts
+const calloutRegex = new RegExp(/^\[\!(\w+)\]([+-]?)/)
+
export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
const opts = { ...defaultOptions, ...userOpts }
return {
name: "ObsidianFlavoredMarkdown",
+ textTransform(src) {
+ // pre-transform wikilinks (fix anchors to things that may contain illegal syntax e.g. codeblocks, latex)
+ if (opts.wikilinks) {
+ src = src.toString()
+ return src.replaceAll(wikilinkRegex, (value, ...capture) => {
+ const [fp, rawHeader, rawAlias] = capture
+ const anchor = rawHeader?.trim().slice(1)
+ const displayAnchor = anchor ? `#${slugAnchor(anchor)}` : ""
+ const displayAlias = rawAlias ?? ""
+ const embedDisplay = value.startsWith("!") ? "!" : ""
+ return `${embedDisplay}[[${fp}${displayAnchor}${displayAlias}]]`
+ })
+ }
+ return src
+ },
markdownPlugins() {
const plugins: PluggableList = []
if (opts.wikilinks) {
plugins.push(() => {
- // Match wikilinks
- // !? -> 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)
- const backlinkRegex = new RegExp(/!?\[\[([^\[\]\|\#]+)(#[^\[\]\|\#]+)?(\|[^\[\]\|\#]+)?\]\]/, "g")
return (tree: Root, _file) => {
- findAndReplace(tree, backlinkRegex, (value: string, ...capture: string[]) => {
- const [fp, rawHeader, rawAlias] = capture
+ findAndReplace(tree, wikilinkRegex, (value: string, ...capture: string[]) => {
+ let [fp, rawHeader, rawAlias] = capture
+ fp = fp.trim()
const anchor = rawHeader?.trim() ?? ""
const alias = rawAlias?.slice(1).trim()
// embed cases
if (value.startsWith("!")) {
- const ext = path.extname(fp).toLowerCase()
- const url = slugify(fp.trim()) + ext
+ const ext: string | undefined = path.extname(fp).toLowerCase()
+ const url = slugifyFilePath(fp as FilePath) + ext
if ([".png", ".jpg", ".jpeg", ".gif", ".bmp", ".svg"].includes(ext)) {
const dims = alias ?? ""
let [width, height] = dims.split("x", 2)
@@ -146,12 +177,15 @@
type: 'html',
value: `<iframe src="${url}"></iframe>`
}
+ } else {
+ // TODO: this is the node embed case
}
// otherwise, fall through to regular link
}
// internal link
- const url = slugify(fp.trim() + anchor)
+ // const url = transformInternalLink(fp + anchor)
+ const url = fp + anchor
return {
type: 'link',
url,
@@ -168,8 +202,6 @@
if (opts.highlight) {
plugins.push(() => {
- // Match highlights
- const highlightRegex = new RegExp(/==(.+)==/, "g")
return (tree: Root, _file) => {
findAndReplace(tree, highlightRegex, (_value: string, ...capture: string[]) => {
const [inner] = capture
@@ -181,11 +213,22 @@
}
})
}
+
+ if (opts.comments) {
+ plugins.push(() => {
+ return (tree: Root, _file) => {
+ findAndReplace(tree, commentRegex, (_value: string, ..._capture: string[]) => {
+ return {
+ type: 'text',
+ value: ''
+ }
+ })
+ }
+ })
+ }
if (opts.callouts) {
plugins.push(() => {
- // from https://github.com/escwxyz/remark-obsidian-callout/blob/main/src/index.ts
- const calloutRegex = new RegExp(/^\[\!(\w+)\]([+-]?)/)
return (tree: Root, _file) => {
visit(tree, "blockquote", (node) => {
if (node.children.length === 0) {
@@ -199,6 +242,7 @@
}
const text = firstChild.children[0].value
+ const restChildren = firstChild.children.splice(1)
const [firstLine, ...remainingLines] = text.split("\n")
const remainingText = remainingLines.join("\n")
@@ -210,6 +254,10 @@
const defaultState = collapseChar === "-" ? "collapsed" : "expanded"
const title = match.input.slice(calloutDirective.length).trim() || capitalize(calloutType)
+ const toggleIcon = `<svg 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" class="fold">
+ <polyline points="6 9 12 15 18 9"></polyline>
+ </svg>`
+
const titleNode: HTML = {
type: "html",
value: `<div
@@ -217,6 +265,7 @@
>
<div class="callout-icon">${callouts[canonicalizeCallout(calloutType)]}</div>
<div class="callout-title-inner">${title}</div>
+ ${collapse ? toggleIcon : ""}
</div>`
}
@@ -227,8 +276,7 @@
children: [{
type: 'text',
value: remainingText,
- }]
-
+ }, ...restChildren]
})
}
@@ -236,7 +284,6 @@
node.children.splice(0, 1, ...blockquoteContent)
// add properties to base blockquote
- // TODO: add the js to actually support collapsing callout
node.data = {
hProperties: {
...(node.data?.hProperties ?? {}),
@@ -273,18 +320,29 @@
return [rehypeRaw]
},
externalResources() {
- const mermaidScript: JSResource = {
- script: `
+ const js: JSResource[] = []
+
+ if (opts.callouts) {
+ js.push({
+ script: calloutScript,
+ loadTime: 'afterDOMReady',
+ contentType: 'inline'
+ })
+ }
+
+ if (opts.mermaid) {
+ js.push({
+ script: `
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.esm.min.mjs';
mermaid.initialize({ startOnLoad: true });
`,
- loadTime: 'afterDOMReady',
- moduleType: 'module',
- contentType: 'inline'
+ loadTime: 'afterDOMReady',
+ moduleType: 'module',
+ contentType: 'inline'
+ })
}
- return {
- js: opts.mermaid ? [mermaidScript] : []
- }
+
+ return { js }
}
}
}
--
Gitblit v1.10.0