From df02ea20d7e12e8b9ffdd2968afaf5893c433488 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Fri, 11 Aug 2023 04:32:11 +0000
Subject: [PATCH] spacing fix
---
quartz/plugins/transformers/ofm.ts | 283 +++++++++++++++++++++++++++++++++++++-------------------
1 files changed, 186 insertions(+), 97 deletions(-)
diff --git a/quartz/plugins/transformers/ofm.ts b/quartz/plugins/transformers/ofm.ts
index a7f8f59..e7438aa 100644
--- a/quartz/plugins/transformers/ofm.ts
+++ b/quartz/plugins/transformers/ofm.ts
@@ -1,15 +1,18 @@
import { PluggableList } from "unified"
import { QuartzTransformerPlugin } from "../types"
-import { Root, HTML, BlockContent, DefinitionContent, Code } from 'mdast'
-import { findAndReplace } from "mdast-util-find-and-replace"
-import { slug as slugAnchor } from 'github-slugger'
+import { Root, HTML, BlockContent, DefinitionContent, Code } from "mdast"
+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"
// @ts-ignore
import calloutScript from "../../components/scripts/callout.inline.ts"
-import { FilePath, slugifyFilePath, transformInternalLink } from "../../path"
+import { FilePath, canonicalizeServer, pathToRoot, slugTag, slugifyFilePath } from "../../path"
+import { toHast } from "mdast-util-to-hast"
+import { toHtml } from "hast-util-to-html"
+import { PhrasingContent } from "mdast-util-find-and-replace/lib"
export interface Options {
comments: boolean
@@ -17,6 +20,8 @@
wikilinks: boolean
callouts: boolean
mermaid: boolean
+ parseTags: boolean
+ enableInHtmlEmbed: boolean
}
const defaultOptions: Options = {
@@ -25,6 +30,8 @@
wikilinks: true,
callouts: true,
mermaid: true,
+ parseTags: true,
+ enableInHtmlEmbed: false,
}
const icons = {
@@ -43,40 +50,6 @@
quoteIcon: `<svg xmlns="http://www.w3.org/2000/svg" width="100%" height="100%" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M3 21c3 0 7-1 7-8V5c0-1.25-.756-2.017-2-2H4c-1.25 0-2 .75-2 1.972V11c0 1.25.75 2 2 2 1 0 1 0 1 1v1c0 1-1 2-2 2s-1 .008-1 1.031V20c0 1 0 1 1 1z"></path><path d="M15 21c3 0 7-1 7-8V5c0-1.25-.757-2.017-2-2h-4c-1.25 0-2 .75-2 1.972V11c0 1.25.75 2 2 2h.75c0 2.25.25 4-2.75 4v3c0 1 0 1 1 1z"></path></svg>`,
}
-function canonicalizeCallout(calloutName: string): keyof typeof callouts {
- let callout = calloutName.toLowerCase() as keyof typeof calloutMapping
-
- const calloutMapping: Record<string, keyof typeof callouts> = {
- note: "note",
- abstract: "abstract",
- info: "info",
- todo: "todo",
- tip: "tip",
- hint: "tip",
- important: "tip",
- success: "success",
- check: "success",
- done: "success",
- question: "question",
- help: "question",
- faq: "question",
- warning: "warning",
- attention: "warning",
- caution: "warning",
- failure: "failure",
- missing: "failure",
- fail: "failure",
- danger: "danger",
- error: "danger",
- bug: "bug",
- example: "example",
- quote: "quote",
- cite: "quote"
- }
-
- return calloutMapping[callout]
-}
-
const callouts = {
note: icons.pencilIcon,
abstract: icons.clipboardListIcon,
@@ -93,32 +66,97 @@
quote: icons.quoteIcon,
}
-const capitalize = (s: string): string => {
- return s.substring(0, 1).toUpperCase() + s.substring(1);
+const calloutMapping: Record<string, keyof typeof callouts> = {
+ note: "note",
+ abstract: "abstract",
+ info: "info",
+ todo: "todo",
+ tip: "tip",
+ hint: "tip",
+ important: "tip",
+ success: "success",
+ check: "success",
+ done: "success",
+ question: "question",
+ help: "question",
+ faq: "question",
+ warning: "warning",
+ attention: "warning",
+ caution: "warning",
+ failure: "failure",
+ missing: "failure",
+ fail: "failure",
+ danger: "danger",
+ error: "danger",
+ bug: "bug",
+ example: "example",
+ quote: "quote",
+ cite: "quote",
}
-// Match wikilinks
+function canonicalizeCallout(calloutName: string): keyof typeof callouts {
+ let callout = calloutName.toLowerCase() as keyof typeof calloutMapping
+ return calloutMapping[callout] ?? calloutName
+}
+
+const capitalize = (s: string): string => {
+ return s.substring(0, 1).toUpperCase() + s.substring(1)
+}
+
// !? -> 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+)\]([+-]?)/)
+// (?:^| ) -> 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) => {
+export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin<Partial<Options> | undefined> = (
+ userOpts,
+) => {
const opts = { ...defaultOptions, ...userOpts }
+
+ const findAndReplace = opts.enableInHtmlEmbed
+ ? (tree: Root, regex: RegExp, replace?: Replace | null | undefined) => {
+ if (replace) {
+ const mdastToHtml = (ast: PhrasingContent) => {
+ const hast = toHast(ast, { allowDangerousHtml: true })!
+ return toHtml(hast, { allowDangerousHtml: true })
+ }
+
+ visit(tree, "html", (node: HTML) => {
+ if (typeof replace === "string") {
+ node.value = node.value.replace(regex, replace)
+ } else {
+ node.value = node.value.replaceAll(regex, (substring: string, ...args) => {
+ const replaceValue = replace(substring, ...args)
+ if (typeof replaceValue === "string") {
+ return replaceValue
+ } else if (Array.isArray(replaceValue)) {
+ return replaceValue.map(mdastToHtml).join("")
+ } else if (typeof replaceValue === "object" && replaceValue !== null) {
+ return mdastToHtml(replaceValue)
+ } else {
+ return substring
+ }
+ })
+ }
+ })
+ }
+
+ mdastFindReplace(tree, regex, replace)
+ }
+ : mdastFindReplace
+
return {
name: "ObsidianFlavoredMarkdown",
- textTransform(src) {
+ 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()
@@ -146,7 +184,7 @@
// embed cases
if (value.startsWith("!")) {
- const ext: string | undefined = path.extname(fp).toLowerCase()
+ const ext: string = path.extname(fp).toLowerCase()
const url = slugifyFilePath(fp as FilePath) + ext
if ([".png", ".jpg", ".jpeg", ".gif", ".bmp", ".svg"].includes(ext)) {
const dims = alias ?? ""
@@ -154,50 +192,53 @@
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
+ } else if (ext === "") {
+ // TODO: note embed
}
// otherwise, fall through to regular link
}
// internal link
- // 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) {
@@ -206,21 +247,21 @@
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: ''
+ type: "text",
+ value: "",
}
})
}
@@ -249,10 +290,13 @@
const match = firstLine.match(calloutRegex)
if (match && match.input) {
const [calloutDirective, typeString, collapseChar] = match
- const calloutType = typeString.toLowerCase() as keyof typeof callouts
+ const calloutType = canonicalizeCallout(
+ typeString.toLowerCase() as keyof typeof calloutMapping,
+ )
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>
@@ -263,20 +307,23 @@
value: `<div
class="callout-title"
>
- <div class="callout-icon">${callouts[canonicalizeCallout(calloutType)]}</div>
+ <div class="callout-icon">${callouts[calloutType]}</div>
<div class="callout-title-inner">${title}</div>
${collapse ? toggleIcon : ""}
- </div>`
+ </div>`,
}
const blockquoteContent: (BlockContent | DefinitionContent)[] = [titleNode]
if (remainingText.length > 0) {
blockquoteContent.push({
- type: 'paragraph',
- children: [{
- type: 'text',
- value: remainingText,
- }, ...restChildren]
+ type: "paragraph",
+ children: [
+ {
+ type: "text",
+ value: remainingText,
+ },
+ ...restChildren,
+ ],
})
}
@@ -287,10 +334,12 @@
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,
- }
+ },
}
}
})
@@ -301,12 +350,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"],
+ },
}
}
})
@@ -314,6 +363,36 @@
})
}
+ 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/${slugTag(tag)}`,
+ data: {
+ hProperties: {
+ className: ["tag-link"],
+ },
+ },
+ children: [
+ {
+ type: "text",
+ value,
+ },
+ ],
+ }
+ })
+ }
+ })
+ }
+
return plugins
},
htmlPlugins() {
@@ -325,8 +404,8 @@
if (opts.callouts) {
js.push({
script: calloutScript,
- loadTime: 'afterDOMReady',
- contentType: 'inline'
+ loadTime: "afterDOMReady",
+ contentType: "inline",
})
}
@@ -334,15 +413,25 @@
js.push({
script: `
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.esm.min.mjs';
- mermaid.initialize({ startOnLoad: true });
+ 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'
+ })
+ });
`,
- loadTime: 'afterDOMReady',
- moduleType: 'module',
- contentType: 'inline'
+ loadTime: "afterDOMReady",
+ moduleType: "module",
+ contentType: "inline",
})
}
return { js }
- }
+ },
}
}
--
Gitblit v1.10.0