| | |
| | | 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 { slug as slugAnchor } from "github-slugger" |
| | | import rehypeRaw from "rehype-raw" |
| | | import { SKIP, visit } from "unist-util-visit" |
| | | import path from "path" |
| | | import { JSResource } from "../../util/resources" |
| | | import { splitAnchor } from "../../util/path" |
| | | import { JSResource, CSSResource } from "../../util/resources" |
| | | // @ts-ignore |
| | | import calloutScript from "../../components/scripts/callout.inline.ts" |
| | | // @ts-ignore |
| | |
| | | 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" |
| | | |
| | |
| | | |
| | | export const externalLinkRegex = /^https?:\/\//i |
| | | |
| | | export const arrowRegex = new RegExp(/(-{1,2}>|={1,2}>|<-{1,2}|<={1,2})/, "g") |
| | | export const arrowRegex = new RegExp(/(-{1,2}>|={1,2}>|<-{1,2}|<={1,2})/g) |
| | | |
| | | // (\|[^\|\[\n]*)? -> optional check if wikilink is inside a table cell |
| | | // !? -> 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) |
| | | // ([^\|\n]*\|)? -> optional check if wikilink is inside a table cell |
| | | // !? -> optional embedding |
| | | // \[\[ -> open brace |
| | | // ([^\[\]\|\#]+) -> one or more non-special characters ([,],|, or #) (name) |
| | | // (#[^\[\]\|\#]+)? -> # then one or more non-special characters (heading link) |
| | | // (\\?\|[^\[\]\#]+)? -> optional escape \ then | then one or more non-special characters (alias) |
| | | export const wikilinkRegex = new RegExp( |
| | | /(\|[^\|\[\n]*)?!?\[\[([^\[\]\|\#\\]+)?(#+[^\[\]\|\#\\]+)?(\\?\|[^\[\]\#]+)?\]\]([^\|\n]*\|)?/, |
| | | "g", |
| | | /!?\[\[([^\[\]\|\#\\]+)?(#+[^\[\]\|\#\\]+)?(\\?\|[^\[\]\#]+)?\]\]/g, |
| | | ) |
| | | const highlightRegex = new RegExp(/==([^=]+)==/, "g") |
| | | const commentRegex = new RegExp(/%%[\s\S]*?%%/, "g") |
| | | |
| | | // ^\|([^\n])+\|\n(\|) -> matches the header row |
| | | // ( ?:?-{3,}:? ?\|)+ -> matches the header row separator |
| | | // (\|([^\n])+\|\n)+ -> matches the body rows |
| | | 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) |
| | | |
| | | 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 calloutLineRegex = new RegExp(/^> *\[\!\w+\][+-]?.*$/, "gm") |
| | | // (?:^| ) -> non-capturing group, tag should start be separated by a space or be the start of the line |
| | | const calloutRegex = new RegExp(/^\[\!([\w-]+)\|?(.+?)?\]([+-]?)/) |
| | | const calloutLineRegex = new RegExp(/^> *\[\!\w+\|?.*?\][+-]?.*$/gm) |
| | | // (?<=^| ) -> 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 blockReferenceRegex = new RegExp(/\^([-_A-Za-z0-9]+)$/g) |
| | | const ytLinkRegex = /^.*(youtu.be\/|v\/|u\/\w\/|embed\/|watch\?v=|\&v=)([^#\&\?]*).*/ |
| | | const ytPlaylistLinkRegex = /[?&]list=([^#?&]*)/ |
| | | const videoExtensionRegex = new RegExp(/\.(mp4|webm|ogg|avi|mov|flv|wmv|mkv|mpg|mpeg|3gp|m4v)$/) |
| | |
| | | /^(?<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) => { |
| | |
| | | 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> " |
| | |
| | | |
| | | // 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 |
| | | return value.replace(tableWikilinkRegex, (_value, raw) => { |
| | | // const [raw]: (string | undefined)[] = capture |
| | | let escaped = raw ?? "" |
| | | escaped = escaped.replace("#", "\\#") |
| | | // escape pipe characters if they are not already escaped |
| | | escaped = escaped.replace(/((^|[^\\])(\\\\)*)\|/g, "$1\\|") |
| | | |
| | | return escaped |
| | | }) |
| | | }) |
| | | |
| | | // replace all other wikilinks |
| | | src = src.replace(wikilinkRegex, (value, ...capture) => { |
| | | const [rawTablePre, rawFp, rawHeader, rawAlias, rawTablePost]: (string | undefined)[] = |
| | | capture |
| | | const [rawFp, rawHeader, rawAlias]: (string | undefined)[] = capture |
| | | |
| | | const fp = rawFp ?? "" |
| | | const anchor = rawHeader?.trim().replace(/^#+/, "") |
| | | const blockRef = Boolean(anchor?.startsWith("^")) ? "^" : "" |
| | | const displayAnchor = anchor ? `#${blockRef}${slugAnchor(anchor)}` : "" |
| | | let displayAlias = rawAlias ?? rawHeader?.replace("#", "|") ?? "" |
| | | const [fp, anchor] = splitAnchor(`${rawFp ?? ""}${rawHeader ?? ""}`) |
| | | const blockRef = Boolean(rawHeader?.match(/^#?\^/)) ? "^" : "" |
| | | const displayAnchor = anchor ? `#${blockRef}${anchor.trim().replace(/^#+/, "")}` : "" |
| | | const displayAlias = rawAlias ?? rawHeader?.replace("#", "|") ?? "" |
| | | const embedDisplay = value.startsWith("!") ? "!" : "" |
| | | |
| | | if (rawFp?.match(externalLinkRegex)) { |
| | | return `${embedDisplay}[${displayAlias.replace(/^\|/, "")}](${rawFp})` |
| | | } |
| | | |
| | | // transform `[[note#^block_ref|^block_ref]]` to `[[note#^block_ref\|^block_ref]]`, |
| | | // when the wikilink with alias is inside a table. |
| | | if (displayAlias && displayAlias.startsWith("|") && rawTablePre && rawTablePost) { |
| | | displayAlias = `\\${displayAlias}` |
| | | } |
| | | |
| | | return `${embedDisplay}[[${fp}${displayAnchor}${displayAlias}]]` |
| | | }) |
| | | } |
| | |
| | | replacements.push([ |
| | | wikilinkRegex, |
| | | (value: string, ...capture: string[]) => { |
| | | let [_rawTablePre, rawFp, rawHeader, rawAlias, _rawTablePost] = capture |
| | | let [rawFp, rawHeader, rawAlias] = capture |
| | | const fp = rawFp?.trim() ?? "" |
| | | const anchor = rawHeader?.trim() ?? "" |
| | | const alias = rawAlias?.slice(1).trim() |
| | |
| | | } else if ([".pdf"].includes(ext)) { |
| | | return { |
| | | type: "html", |
| | | value: `<iframe src="${url}"></iframe>`, |
| | | value: `<iframe src="${url}" class="pdf"></iframe>`, |
| | | } |
| | | } else { |
| | | const block = anchor |
| | | return { |
| | | type: "html", |
| | | data: { hProperties: { transclude: true } }, |
| | | value: `<blockquote class="transclude" data-url="${url}" data-block="${block}"><a href="${ |
| | | value: `<blockquote class="transclude" data-url="${url}" data-block="${block}" data-embed-alias="${alias}"><a href="${ |
| | | url + anchor |
| | | }" class="transclude-inner">Transclude of ${url}${block}</a></blockquote>`, |
| | | } |
| | |
| | | |
| | | // internal link |
| | | const url = fp + anchor |
| | | |
| | | return { |
| | | type: "link", |
| | | url, |
| | |
| | | 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 |
| | | } |
| | | |
| | |
| | | return |
| | | } |
| | | |
| | | // find first line |
| | | const firstChild = node.children[0] |
| | | // find first line and callout content |
| | | const [firstChild, ...calloutContent] = node.children |
| | | if (firstChild.type !== "paragraph" || firstChild.children[0]?.type !== "text") { |
| | | return |
| | | } |
| | |
| | | |
| | | const match = firstLine.match(calloutRegex) |
| | | if (match && match.input) { |
| | | const [calloutDirective, typeString, collapseChar] = match |
| | | const [calloutDirective, typeString, calloutMetaData, collapseChar] = match |
| | | const calloutType = canonicalizeCallout(typeString.toLowerCase()) |
| | | const collapse = collapseChar === "+" || collapseChar === "-" |
| | | const defaultState = collapseChar === "-" ? "collapsed" : "expanded" |
| | |
| | | children: [ |
| | | { |
| | | type: "text", |
| | | value: useDefaultTitle ? capitalize(typeString) : titleContent + " ", |
| | | value: useDefaultTitle |
| | | ? capitalize(typeString).replace(/-/g, " ") |
| | | : titleContent + " ", |
| | | }, |
| | | ...restOfTitle, |
| | | ], |
| | |
| | | className: classNames.join(" "), |
| | | "data-callout": calloutType, |
| | | "data-callout-fold": collapse, |
| | | "data-callout-metadata": calloutMetaData, |
| | | }, |
| | | } |
| | | |
| | | // Add callout-content class to callout body if it has one. |
| | | if (calloutContent.length > 0) { |
| | | const contentData: BlockContent | DefinitionContent = { |
| | | data: { |
| | | hProperties: { |
| | | className: "callout-content", |
| | | }, |
| | | hName: "div", |
| | | }, |
| | | type: "blockquote", |
| | | children: [...calloutContent], |
| | | } |
| | | node.children = [node.children[0], contentData] |
| | | } |
| | | } |
| | | }) |
| | | } |
| | |
| | | |
| | | 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), |
| | | }, |
| | | } |
| | | } |
| | |
| | | // YouTube video (with optional playlist) |
| | | node.tagName = "iframe" |
| | | node.properties = { |
| | | class: "external-embed", |
| | | class: "external-embed youtube", |
| | | allow: "fullscreen", |
| | | frameborder: 0, |
| | | width: "600px", |
| | | height: "350px", |
| | | src: playlistId |
| | | ? `https://www.youtube.com/embed/${videoId}?list=${playlistId}` |
| | | : `https://www.youtube.com/embed/${videoId}`, |
| | |
| | | // YouTube playlist only. |
| | | node.tagName = "iframe" |
| | | node.properties = { |
| | | class: "external-embed", |
| | | class: "external-embed youtube", |
| | | allow: "fullscreen", |
| | | frameborder: 0, |
| | | width: "600px", |
| | | height: "350px", |
| | | src: `https://www.youtube.com/embed/videoseries?list=${playlistId}`, |
| | | } |
| | | } |
| | |
| | | }) |
| | | } |
| | | |
| | | 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", |
| | | "aria-hidden": "true", |
| | | "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" }, |
| | | children: [ |
| | | { |
| | | type: "element", |
| | | tagName: "div", |
| | | properties: { id: "mermaid-space" }, |
| | | children: [ |
| | | { |
| | | type: "element", |
| | | tagName: "div", |
| | | properties: { className: ["mermaid-header"] }, |
| | | children: [ |
| | | { |
| | | type: "element", |
| | | tagName: "button", |
| | | properties: { |
| | | className: ["close-button"], |
| | | "aria-label": "close button", |
| | | }, |
| | | children: [ |
| | | { |
| | | type: "element", |
| | | tagName: "svg", |
| | | properties: { |
| | | "aria-hidden": "true", |
| | | 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", |
| | | }, |
| | | children: [ |
| | | { |
| | | type: "element", |
| | | tagName: "line", |
| | | properties: { |
| | | x1: 18, |
| | | y1: 6, |
| | | x2: 6, |
| | | y2: 18, |
| | | }, |
| | | children: [], |
| | | }, |
| | | { |
| | | type: "element", |
| | | tagName: "line", |
| | | properties: { |
| | | x1: 6, |
| | | y1: 6, |
| | | x2: 18, |
| | | y2: 18, |
| | | }, |
| | | children: [], |
| | | }, |
| | | ], |
| | | }, |
| | | ], |
| | | }, |
| | | ], |
| | | }, |
| | | { |
| | | type: "element", |
| | | tagName: "div", |
| | | properties: { className: ["mermaid-content"] }, |
| | | children: [], |
| | | }, |
| | | ], |
| | | }, |
| | | ], |
| | | }, |
| | | ] |
| | | } |
| | | }) |
| | | } |
| | | }) |
| | | } |
| | | |
| | | return plugins |
| | | }, |
| | | externalResources() { |
| | | const js: JSResource[] = [] |
| | | const css: CSSResource[] = [] |
| | | |
| | | if (opts.enableCheckbox) { |
| | | js.push({ |
| | |
| | | }) |
| | | } |
| | | |
| | | 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' |
| | | }) |
| | | } |
| | | }); |
| | | `, |
| | | loadTime: "afterDOMReady", |
| | | moduleType: "module", |
| | | contentType: "inline", |
| | | }) |
| | | } |
| | | |
| | | return { js } |
| | | return { js, css } |
| | | }, |
| | | } |
| | | } |
| | |
| | | interface DataMap { |
| | | blocks: Record<string, Element> |
| | | htmlAst: HtmlRoot |
| | | hasMermaidDiagram: boolean | undefined |
| | | } |
| | | } |