Obsidian Parser (Comments)

quartz/plugins/parsers/obsidian/comments.ts

@@ -0,0 +1,49 @@
+import { QuartzParserPlugin } from "../../types"
+import { ReplaceFunction, findAndReplace as mdastFindReplace } from "mdast-util-find-and-replace"
+import { JSResource } from "../../../util/resources"
+import { Root } from "mdast"
+import { Pluggable } from "unified"
+
+interface Options {
+  enabled: Boolean
+}
+
+const defaultOptions: Options = {
+  enabled: true,
+}
+
+const commentRegex = new RegExp(/%%[\s\S]*?%%/g)
+
+export const ObsidianComments: QuartzParserPlugin<Partial<Options>> = (userOpts) => {
+  const opts: Options = { ...defaultOptions, ...userOpts }
+  return {
+    name: "ObsidianComments",
+    textTransform(_ctx, src: string | Buffer) {
+      // do comments at text level
+      if (src instanceof Buffer) {
+        src = src.toString()
+      }
+
+      src = src.replace(commentRegex, "")
+
+      return src
+    },
+    markdownPlugins(_ctx) {
+      const plug: Pluggable = (tree: Root, _file) => {
+        if (opts.enabled) {
+          const replacements: [RegExp, string | ReplaceFunction][] = []
+          mdastFindReplace(tree, replacements)
+        }
+      }
+      return plug
+    },
+    htmlPlugins(_ctx) {
+      const plug: Pluggable = () => {}
+      return plug
+    },
+    externalResources(_ctx) {
+      const js = [] as JSResource[]
+      return { js }
+    },
+  }
+}

quartz/plugins/parsers/obsidian/index.ts

@@ -1,4 +1,5 @@
 export { ObsidianArrow } from "./arrows"
 export { ObsidianCallouts } from "./callouts"
+export { ObsidianComments } from "./comments"
 export { ObsidianHighlights } from "./highlights"
 export { ObsidianWikilinks } from "./wikilinks"

quartz/plugins/transformers/markdown.ts

@@ -38,6 +38,7 @@ import rehypeAutolinkHeadings from "rehype-autolink-headings"
 import {
   ObsidianArrow,
   ObsidianCallouts,
+  ObsidianComments,
   ObsidianHighlights,
   ObsidianWikilinks,
 } from "../parsers/obsidian"
@@ -178,6 +179,7 @@ export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin<Partial<ObsidianO
   return {
     name: "ObsidianFlavoredMarkdown",
     textTransform(ctx, src) {
+      src = ObsidianComments({ enabled: opts.comments }).textTransform(ctx, src)
       src = ObsidianCallouts({ enabled: opts.callouts }).textTransform(ctx, src)
       src = ObsidianWikilinks({ enabled: opts.wikilinks }).textTransform(ctx, src)