From b34d521293415944370fd0f5cf25cd71bcffb5b6 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Fri, 18 Apr 2025 02:45:17 +0000
Subject: [PATCH] feat: reader mode
---
quartz/plugins/transformers/ofm.ts | 162 ++++++++++++++++++++++++++++++++++++-----------------
1 files changed, 110 insertions(+), 52 deletions(-)
diff --git a/quartz/plugins/transformers/ofm.ts b/quartz/plugins/transformers/ofm.ts
index dd2eaee..5c2f4b2 100644
--- a/quartz/plugins/transformers/ofm.ts
+++ b/quartz/plugins/transformers/ofm.ts
@@ -1,20 +1,30 @@
import { QuartzTransformerPlugin } from "../types"
-import { Root, Html, BlockContent, DefinitionContent, Paragraph, Code } from "mdast"
+import {
+ Root,
+ Html,
+ BlockContent,
+ PhrasingContent,
+ 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 rehypeRaw from "rehype-raw"
import { SKIP, visit } from "unist-util-visit"
import path from "path"
import { splitAnchor } from "../../util/path"
-import { JSResource } from "../../util/resources"
+import { JSResource, CSSResource } from "../../util/resources"
// @ts-ignore
-import calloutScript from "../../components/scripts/callout.inline.ts"
+import calloutScript from "../../components/scripts/callout.inline"
// @ts-ignore
-import checkboxScript from "../../components/scripts/checkbox.inline.ts"
+import checkboxScript from "../../components/scripts/checkbox.inline"
+// @ts-ignore
+import mermaidScript from "../../components/scripts/mermaid.inline"
+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"
-import { PhrasingContent } from "mdast-util-find-and-replace/lib"
import { capitalize } from "../../util/lang"
import { PluggableList } from "unified"
@@ -114,19 +124,19 @@
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)
+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 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
+// (?<=^| ) -> a lookbehind assertion, 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}\p{M}\d])+(?:\/[-_\p{L}\p{Emoji}\p{M}\d]+)*)/gu,
+ /(?<=^| )#((?:[-_\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=)([^#\&\?]*).*/
@@ -136,9 +146,7 @@
/^(?<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) => {
@@ -151,19 +159,11 @@
textTransform(_ctx, src) {
// do comments at text level
if (opts.comments) {
- if (src instanceof Buffer) {
- src = src.toString()
- }
-
src = src.replace(commentRegex, "")
}
// pre-transform blockquotes
if (opts.callouts) {
- if (src instanceof Buffer) {
- src = src.toString()
- }
-
src = src.replace(calloutLineRegex, (value) => {
// force newline after title of callout
return value + "\n> "
@@ -172,10 +172,6 @@
// pre-transform wikilinks (fix anchors to things that may contain illegal syntax e.g. codeblocks, latex)
if (opts.wikilinks) {
- if (src instanceof Buffer) {
- src = src.toString()
- }
-
// replace all wikilinks inside a table first
src = src.replace(tableRegex, (value) => {
// escape all aliases and headers in wikilinks inside a table
@@ -195,8 +191,7 @@
const [rawFp, rawHeader, rawAlias]: (string | undefined)[] = capture
const [fp, anchor] = splitAnchor(`${rawFp ?? ""}${rawHeader ?? ""}`)
- const blockRef = Boolean(rawHeader?.match(/^#?\^/)) ? "^" : ""
- const displayAnchor = anchor ? `#${blockRef}${anchor.trim().replace(/^#+/, "")}` : ""
+ const displayAnchor = anchor ? `#${anchor.trim().replace(/^#+/, "")}` : ""
const displayAlias = rawAlias ?? rawHeader?.replace("#", "|") ?? ""
const embedDisplay = value.startsWith("!") ? "!" : ""
@@ -263,7 +258,7 @@
} else if ([".pdf"].includes(ext)) {
return {
type: "html",
- value: `<iframe src="${url}"></iframe>`,
+ value: `<iframe src="${url}" class="pdf"></iframe>`,
}
} else {
const block = anchor
@@ -281,6 +276,7 @@
// internal link
const url = fp + anchor
+
return {
type: "link",
url,
@@ -326,8 +322,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
}
@@ -432,7 +428,9 @@
children: [
{
type: "text",
- value: useDefaultTitle ? capitalize(typeString) : titleContent + " ",
+ value: useDefaultTitle
+ ? capitalize(typeString).replace(/-/g, " ")
+ : titleContent + " ",
},
...restOfTitle,
],
@@ -509,12 +507,14 @@
if (opts.mermaid) {
plugins.push(() => {
- return (tree: Root, _file) => {
+ return (tree: Root, file) => {
visit(tree, "code", (node: Code) => {
if (node.lang === "mermaid") {
+ file.data.hasMermaidDiagram = true
node.data = {
hProperties: {
className: ["mermaid"],
+ "data-clipboard": JSON.stringify(node.value),
},
}
}
@@ -659,10 +659,80 @@
})
}
+ 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",
+ "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", role: "dialog" },
+ children: [
+ {
+ type: "element",
+ tagName: "div",
+ properties: { id: "mermaid-space" },
+ children: [
+ {
+ type: "element",
+ tagName: "div",
+ properties: { className: ["mermaid-content"] },
+ children: [],
+ },
+ ],
+ },
+ ],
+ },
+ ]
+ }
+ })
+ }
+ })
+ }
+
return plugins
},
externalResources() {
const js: JSResource[] = []
+ const css: CSSResource[] = []
if (opts.enableCheckbox) {
js.push({
@@ -682,32 +752,19 @@
if (opts.mermaid) {
js.push({
- script: `
- let mermaidImport = undefined
- document.addEventListener('nav', async () => {
- if (document.querySelector("code.mermaid")) {
- mermaidImport ||= await import('https://cdnjs.cloudflare.com/ajax/libs/mermaid/10.7.0/mermaid.esm.min.mjs')
- const mermaid = mermaidImport.default
- const darkMode = document.documentElement.getAttribute('saved-theme') === 'dark'
- mermaid.initialize({
- startOnLoad: false,
- securityLevel: 'loose',
- theme: darkMode ? 'dark' : 'default'
- })
-
- await mermaid.run({
- querySelector: '.mermaid'
- })
- }
- });
- `,
+ script: mermaidScript,
loadTime: "afterDOMReady",
- moduleType: "module",
contentType: "inline",
+ moduleType: "module",
+ })
+
+ css.push({
+ content: mermaidStyle,
+ inline: true,
})
}
- return { js }
+ return { js, css }
},
}
}
@@ -716,5 +773,6 @@
interface DataMap {
blocks: Record<string, Element>
htmlAst: HtmlRoot
+ hasMermaidDiagram: boolean | undefined
}
}
--
Gitblit v1.10.0