From 1929241a62b67ebd9cc9831e372ab321874d03d1 Mon Sep 17 00:00:00 2001
From: Eiko Wagenknecht <git@eiko-wagenknecht.de>
Date: Fri, 23 Feb 2024 20:07:53 +0000
Subject: [PATCH] docs: update plugin documentation (#888)
---
docs/features/Latex.md | 13 ++++++-------
1 files changed, 6 insertions(+), 7 deletions(-)
diff --git a/docs/features/Latex.md b/docs/features/Latex.md
index 3c8f6ff..e019190 100644
--- a/docs/features/Latex.md
+++ b/docs/features/Latex.md
@@ -1,6 +1,7 @@
---
+title: LaTeX
tags:
- - plugin/transformer
+ - feature/transformer
---
Quartz uses [Katex](https://katex.org/) by default to typeset both inline and block math expressions at build time.
@@ -38,6 +39,9 @@
\end{bmatrix}
$$
+> [!warn]
+> Due to limitations in the [underlying parsing library](https://github.com/remarkjs/remark-math), block math in Quartz requires the `$$` delimiters to be on newlines like above.
+
### Inline Math
Similarly, inline math can be rendered by delimiting math expression with a single `$`. For example, `$e^{i\pi} = -1$` produces $e^{i\pi} = -1$
@@ -53,11 +57,6 @@
- Incorrect: `I have $1 and you have $2` produces I have $1 and you have $2
- Correct: `I have \$1 and you have \$2` produces I have \$1 and you have \$2
-## MathJax
-
-In `quartz.config.ts`, you can configure Quartz to use [MathJax SVG rendering](https://docs.mathjax.org/en/latest/output/svg.html) by replacing `Plugin.Latex({ renderEngine: 'katex' })` with `Plugin.Latex({ renderEngine: 'mathjax' })`
-
## Customization
-- Removing Latex support: remove all instances of `Plugin.Latex()` from `quartz.config.ts`.
-- Plugin: `quartz/plugins/transformers/latex.ts`
+Latex parsing is a functionality of the [[plugins/Latex|Latex]] plugin. See the plugin page for customization options.
--
Gitblit v1.10.0