A transformer for Quartz that adds furigana support. A companion to obsidian-markdown-furigana.

furigana.ts

import { QuartzTransformerPlugin } from "../types"
import { findAndReplace } from "mdast-util-find-and-replace"

export const Furigana: QuartzTransformerPlugin = () => {
  return {
    name: "Furigana",
    markdownPlugins() {
      return [
        () => {
          return (tree, _file) => {
            // Match pattern {base|furigana}
            findAndReplace(tree, /\{([^\|]+)\|([^\}]+)\}/g, (_value: string, ...capture: string[]) => {
              const [baseText, furiganaText] = capture
              
              return {
                type: "html",
                value: `<ruby>${baseText}<rt>${furiganaText}</rt></ruby>`
              }
            })
          }
        }
      ]
    }
  }
}

export default Furigana

To use this:

1. add the file into /plugins/transformers/
2. add export { Furigana } from "./furigana" to /plugins/transformers/index.ts
3. in your quartz.config.ts, add Plugin.Furigana() into your transformers section.

Super clean and simple :)