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 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: true, parseTags: true, } const icons = { infoIcon: ``, pencilIcon: ``, clipboardListIcon: ``, checkCircleIcon: ``, flameIcon: ``, checkIcon: ``, helpCircleIcon: ``, alertTriangleIcon: ``, xIcon: ``, zapIcon: ``, bugIcon: ``, listIcon: ``, quoteIcon: ``, } function canonicalizeCallout(calloutName: string): keyof typeof callouts { let callout = calloutName.toLowerCase() as keyof typeof calloutMapping const calloutMapping: Record = { 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, info: icons.infoIcon, todo: icons.checkCircleIcon, tip: icons.flameIcon, success: icons.checkIcon, question: icons.helpCircleIcon, warning: icons.alertTriangleIcon, failure: icons.xIcon, danger: icons.zapIcon, bug: icons.bugIcon, example: icons.listIcon, quote: icons.quoteIcon, } 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") 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 | 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(() => { return (tree: Root, _file) => { 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: 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", url, data: { hProperties: { width, height, }, }, } } else if ([".mp4", ".webm", ".ogv", ".mov", ".mkv"].includes(ext)) { return { type: "html", value: `

`, } } else if ( [".mp3", ".webm", ".wav", ".m4a", ".ogg", ".3gp", ".flac"].includes(ext) ) { return { type: "html", value: `

`, } } else if ([".pdf"].includes(ext)) { return { type: "html", value: ``, } } else { // TODO: this is the node embed case } // otherwise, fall through to regular link } // internal link // const url = transformInternalLink(fp + anchor) const url = fp + anchor return { type: "link", url, children: [ { type: "text", value: alias ?? fp, }, ], } }) } }) } if (opts.highlight) { plugins.push(() => { return (tree: Root, _file) => { findAndReplace(tree, highlightRegex, (_value: string, ...capture: string[]) => { const [inner] = capture return { type: "html", value: `${inner}`, } }) } }) } 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(() => { return (tree: Root, _file) => { visit(tree, "blockquote", (node) => { if (node.children.length === 0) { return } // find first line const firstChild = node.children[0] if (firstChild.type !== "paragraph" || firstChild.children[0]?.type !== "text") { return } const text = firstChild.children[0].value const restChildren = firstChild.children.splice(1) const [firstLine, ...remainingLines] = text.split("\n") const remainingText = remainingLines.join("\n") const match = firstLine.match(calloutRegex) if (match && match.input) { const [calloutDirective, typeString, collapseChar] = match 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 toggleIcon = `` const titleNode: HTML = { type: "html", value: `

${callouts[canonicalizeCallout(calloutType)]}

${title}

${collapse ? toggleIcon : ""}

`, } const blockquoteContent: (BlockContent | DefinitionContent)[] = [titleNode] if (remainingText.length > 0) { blockquoteContent.push({ type: "paragraph", children: [ { type: "text", value: remainingText, }, ...restChildren, ], }) } // replace first line of blockquote with title and rest of the paragraph text node.children.splice(0, 1, ...blockquoteContent) // add properties to base blockquote node.data = { hProperties: { ...(node.data?.hProperties ?? {}), className: `callout ${collapse ? "is-collapsible" : ""} ${ defaultState === "collapsed" ? "is-collapsed" : "" }`, "data-callout": calloutType, "data-callout-fold": collapse, }, } } }) } }) } if (opts.mermaid) { plugins.push(() => { return (tree: Root, _file) => { visit(tree, "code", (node: Code) => { if (node.lang === "mermaid") { node.data = { hProperties: { className: ["mermaid"], }, } } }) } }) } 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 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", }) } return { js } }, } }