From 2f99339dcf93ef50b766263297785a32d9c35250 Mon Sep 17 00:00:00 2001
From: Hrishikesh Barman <geekodour@users.noreply.github.com>
Date: Fri, 29 Sep 2023 18:35:26 +0000
Subject: [PATCH] feat: add transformations for latex in oxhugofm (#510)
---
quartz/plugins/transformers/oxhugofm.ts | 35 +++++++++++++++++++++++++++++++++++
docs/features/OxHugo compatibility.md | 1 +
2 files changed, 36 insertions(+), 0 deletions(-)
diff --git a/docs/features/OxHugo compatibility.md b/docs/features/OxHugo compatibility.md
index b25167f..3143eb1 100644
--- a/docs/features/OxHugo compatibility.md
+++ b/docs/features/OxHugo compatibility.md
@@ -32,6 +32,7 @@
- `replaceFigureWithMdImg`: Whether to replace `<figure/>` with `![]()`
- Formatting
- `removeHugoShortcode`: Whether to remove hugo shortcode syntax (`{{}}`)
+ - `replaceOrgLatex`: Whether to replace org-mode formatting for latex fragments with what `Plugin.Latex` supports.
> [!warning]
>
diff --git a/quartz/plugins/transformers/oxhugofm.ts b/quartz/plugins/transformers/oxhugofm.ts
index 0d7b919..6e70bb1 100644
--- a/quartz/plugins/transformers/oxhugofm.ts
+++ b/quartz/plugins/transformers/oxhugofm.ts
@@ -9,6 +9,9 @@
removeHugoShortcode: boolean
/** Replace <figure/> with ![]() */
replaceFigureWithMdImg: boolean
+
+ /** Replace org latex fragments with $ and $$ */
+ replaceOrgLatex: boolean
}
const defaultOptions: Options = {
@@ -16,12 +19,27 @@
removePredefinedAnchor: true,
removeHugoShortcode: true,
replaceFigureWithMdImg: true,
+ replaceOrgLatex: true,
}
const relrefRegex = new RegExp(/\[([^\]]+)\]\(\{\{< relref "([^"]+)" >\}\}\)/, "g")
const predefinedHeadingIdRegex = new RegExp(/(.*) {#(?:.*)}/, "g")
const hugoShortcodeRegex = new RegExp(/{{(.*)}}/, "g")
const figureTagRegex = new RegExp(/< ?figure src="(.*)" ?>/, "g")
+// \\\\\( -> matches \\(
+// (.+?) -> Lazy match for capturing the equation
+// \\\\\) -> matches \\)
+const inlineLatexRegex = new RegExp(/\\\\\((.+?)\\\\\)/, "g")
+// (?:\\begin{equation}|\\\\\(|\\\\\[) -> start of equation
+// ([\s\S]*?) -> Matches the block equation
+// (?:\\\\\]|\\\\\)|\\end{equation}) -> end of equation
+const blockLatexRegex = new RegExp(
+ /(?:\\begin{equation}|\\\\\(|\\\\\[)([\s\S]*?)(?:\\\\\]|\\\\\)|\\end{equation})/,
+ "g",
+)
+// \$\$[\s\S]*?\$\$ -> Matches block equations
+// \$.*?\$ -> Matches inline equations
+const quartzLatexRegex = new RegExp(/\$\$[\s\S]*?\$\$|\$.*?\$/, "g")
/**
* ox-hugo is an org exporter backend that exports org files to hugo-compatible
@@ -67,6 +85,23 @@
return ``
})
}
+
+ if (opts.replaceOrgLatex) {
+ src = src.toString()
+ src = src.replaceAll(inlineLatexRegex, (value, ...capture) => {
+ const [eqn] = capture
+ return `$${eqn}$`
+ })
+ src = src.replaceAll(blockLatexRegex, (value, ...capture) => {
+ const [eqn] = capture
+ return `$$${eqn}$$`
+ })
+
+ // ox-hugo escapes _ as \_
+ src = src.replaceAll(quartzLatexRegex, (value) => {
+ return value.replaceAll("\\_", "_")
+ })
+ }
return src
},
}
--
Gitblit v1.10.0