From e82ba97a396e4e9d77486b48e6ee8b1dfd1c1b4c Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Mon, 24 Jul 2023 07:07:58 +0000
Subject: [PATCH] actually add processed tag to frontmatter
---
quartz/plugins/transformers/ofm.ts | 231 +++++++++++++++++++++++++++++++++++++++++----------------
1 files changed, 165 insertions(+), 66 deletions(-)
diff --git a/quartz/plugins/transformers/ofm.ts b/quartz/plugins/transformers/ofm.ts
index aa83953..9840ea8 100644
--- a/quartz/plugins/transformers/ofm.ts
+++ b/quartz/plugins/transformers/ofm.ts
@@ -1,25 +1,32 @@
import { PluggableList } from "unified"
import { QuartzTransformerPlugin } from "../types"
-import { Root, HTML, BlockContent, DefinitionContent, Code } from 'mdast'
+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, canonicalizeServer, pathToRoot, slugifyFilePath } from "../../path"
export interface Options {
+ comments: boolean
highlight: boolean
wikilinks: boolean
callouts: boolean
mermaid: boolean
+ parseTags: boolean
}
const defaultOptions: Options = {
+ comments: true,
highlight: true,
wikilinks: true,
callouts: true,
- mermaid: false,
+ mermaid: true,
+ parseTags: true,
}
const icons = {
@@ -66,7 +73,7 @@
bug: "bug",
example: "example",
quote: "quote",
- cite: "quote"
+ cite: "quote",
}
return calloutMapping[callout]
@@ -89,93 +96,136 @@
}
const capitalize = (s: string): string => {
- return s.substring(0, 1).toUpperCase() + s.substring(1);
+ return s.substring(0, 1).toUpperCase() + s.substring(1)
}
-export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
+// !? -> 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")
+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+)\]([+-]?)/)
+// (?:^| ) -> 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")
+
+export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin<Partial<Options> | undefined> = (
+ userOpts,
+) => {
const opts = { ...defaultOptions, ...userOpts }
return {
name: "ObsidianFlavoredMarkdown",
+ textTransform(_ctx, 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)
width ||= "auto"
height ||= "auto"
return {
- type: 'image',
+ type: "image",
url,
data: {
hProperties: {
- width, height
- }
- }
+ width,
+ height,
+ },
+ },
}
} else if ([".mp4", ".webm", ".ogv", ".mov", ".mkv"].includes(ext)) {
return {
- type: 'html',
- value: `<video src="${url}" controls></video>`
+ type: "html",
+ value: `<video src="${url}" controls></video>`,
}
- } else if ([".mp3", ".webm", ".wav", ".m4a", ".ogg", ".3gp", ".flac"].includes(ext)) {
+ } else if (
+ [".mp3", ".webm", ".wav", ".m4a", ".ogg", ".3gp", ".flac"].includes(ext)
+ ) {
return {
- type: 'html',
- value: `<audio src="${url}" controls></audio>`
+ type: "html",
+ value: `<audio src="${url}" controls></audio>`,
}
} else if ([".pdf"].includes(ext)) {
return {
- type: 'html',
- value: `<iframe src="${url}"></iframe>`
+ 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',
+ type: "link",
url,
- children: [{
- type: 'text',
- value: alias ?? fp
- }]
+ children: [
+ {
+ type: "text",
+ value: alias ?? fp,
+ },
+ ],
}
})
}
- }
- )
+ })
}
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
return {
- type: 'html',
- value: `<span class="text-highlight">${inner}</span>`
+ type: "html",
+ value: `<span class="text-highlight">${inner}</span>`,
+ }
+ })
+ }
+ })
+ }
+
+ if (opts.comments) {
+ plugins.push(() => {
+ return (tree: Root, _file) => {
+ findAndReplace(tree, commentRegex, (_value: string, ..._capture: string[]) => {
+ return {
+ type: "text",
+ value: "",
}
})
}
@@ -184,8 +234,6 @@
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 +247,7 @@
}
const text = firstChild.children[0].value
+ const restChildren = firstChild.children.splice(1)
const [firstLine, ...remainingLines] = text.split("\n")
const remainingText = remainingLines.join("\n")
@@ -208,7 +257,12 @@
const calloutType = typeString.toLowerCase() as keyof typeof callouts
const collapse = collapseChar === "+" || collapseChar === "-"
const defaultState = collapseChar === "-" ? "collapsed" : "expanded"
- const title = match.input.slice(calloutDirective.length).trim() || capitalize(calloutType)
+ 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",
@@ -217,18 +271,21 @@
>
<div class="callout-icon">${callouts[canonicalizeCallout(calloutType)]}</div>
<div class="callout-title-inner">${title}</div>
- </div>`
+ ${collapse ? toggleIcon : ""}
+ </div>`,
}
const blockquoteContent: (BlockContent | DefinitionContent)[] = [titleNode]
if (remainingText.length > 0) {
blockquoteContent.push({
- type: 'paragraph',
- children: [{
- type: 'text',
- value: remainingText,
- }]
-
+ type: "paragraph",
+ children: [
+ {
+ type: "text",
+ value: remainingText,
+ },
+ ...restChildren,
+ ],
})
}
@@ -236,14 +293,15 @@
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 ?? {}),
- className: `callout ${collapse ? "is-collapsible" : ""} ${defaultState === "collapsed" ? "is-collapsed" : ""}`,
+ className: `callout ${collapse ? "is-collapsible" : ""} ${
+ defaultState === "collapsed" ? "is-collapsed" : ""
+ }`,
"data-callout": calloutType,
"data-callout-fold": collapse,
- }
+ },
}
}
})
@@ -254,12 +312,12 @@
if (opts.mermaid) {
plugins.push(() => {
return (tree: Root, _file) => {
- visit(tree, 'code', (node: Code) => {
- if (node.lang === 'mermaid') {
+ visit(tree, "code", (node: Code) => {
+ if (node.lang === "mermaid") {
node.data = {
hProperties: {
- className: 'mermaid'
- }
+ className: ["mermaid"],
+ },
}
}
})
@@ -267,24 +325,65 @@
})
}
+ 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) {
+ file.data.frontmatter.tags.push(tag)
+ }
+
+ return {
+ type: "link",
+ url: base + `/tags/${slugAnchor(tag)}`,
+ data: {
+ hProperties: {
+ className: ["tag-link"],
+ },
+ },
+ children: [
+ {
+ type: "text",
+ value,
+ },
+ ],
+ }
+ })
+ }
+ })
+ }
+
return plugins
},
htmlPlugins() {
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