From 9acaa1c8ac8c8afd3fa08d3b1f58a60006fcfc6f Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Fri, 09 Aug 2024 01:19:45 +0000
Subject: [PATCH] feat: custom global latex macros (closes #1325)
---
quartz/plugins/transformers/latex.ts | 10 ++++++++--
docs/plugins/Latex.md | 1 +
2 files changed, 9 insertions(+), 2 deletions(-)
diff --git a/docs/plugins/Latex.md b/docs/plugins/Latex.md
index ac43678..236cbec 100644
--- a/docs/plugins/Latex.md
+++ b/docs/plugins/Latex.md
@@ -12,6 +12,7 @@
This plugin accepts the following configuration options:
- `renderEngine`: the engine to use to render LaTeX equations. Can be `"katex"` for [KaTeX](https://katex.org/) or `"mathjax"` for [MathJax](https://www.mathjax.org/) [SVG rendering](https://docs.mathjax.org/en/latest/output/svg.html). Defaults to KaTeX.
+- `customMacros`: custom macros for all LaTeX blocks. It takes the form of a key-value pair where the key is a new command name and the value is the expansion of the macro. For example: `{"\\R": "\\mathbb{R}"}`
## API
diff --git a/quartz/plugins/transformers/latex.ts b/quartz/plugins/transformers/latex.ts
index c9f6bff..757333a 100644
--- a/quartz/plugins/transformers/latex.ts
+++ b/quartz/plugins/transformers/latex.ts
@@ -5,10 +5,16 @@
interface Options {
renderEngine: "katex" | "mathjax"
+ customMacros: MacroType
+}
+
+interface MacroType {
+ [key: string]: string
}
export const Latex: QuartzTransformerPlugin<Options> = (opts?: Options) => {
const engine = opts?.renderEngine ?? "katex"
+ const macros = opts?.customMacros ?? {}
return {
name: "Latex",
markdownPlugins() {
@@ -16,9 +22,9 @@
},
htmlPlugins() {
if (engine === "katex") {
- return [[rehypeKatex, { output: "html" }]]
+ return [[rehypeKatex, { output: "html", macros }]]
} else {
- return [rehypeMathjax]
+ return [[rehypeMathjax, { macros }]]
}
},
externalResources() {
--
Gitblit v1.10.0