mirror of
https://github.com/gohugoio/hugo.git
synced 2026-08-24 15:28:54 +00:00
Merge commit 'c23d97904fd31ef745bece57133aa1b9275ec20c'
This commit is contained in:
@@ -13,14 +13,14 @@ aliases: [/functions/tomath]
|
||||
|
||||
{{< new-in 0.132.0 />}}
|
||||
|
||||
Hugo uses an embedded instance of the [KaTeX] display engine to render mathematical markup to HTML. You do not need to install the KaTeX display engine.
|
||||
Hugo uses an embedded instance of the [KaTeX][] display engine to render mathematical markup to HTML. You do not need to install the KaTeX display engine.
|
||||
|
||||
```go-html-template
|
||||
{{ transform.ToMath "c = \\pm\\sqrt{a^2 + b^2}" }}
|
||||
```
|
||||
|
||||
> [!note]
|
||||
> By default, Hugo renders mathematical markup to [MathML], and does not require any CSS to display the result.
|
||||
> By default, Hugo renders mathematical markup to [MathML][], and does not require any CSS to display the result.
|
||||
>
|
||||
> To optimize rendering quality and accessibility, use the `htmlAndMathml` output option as described below. This approach requires an external stylesheet.
|
||||
|
||||
@@ -31,13 +31,13 @@ Hugo uses an embedded instance of the [KaTeX] display engine to render mathemati
|
||||
|
||||
## Options
|
||||
|
||||
Pass a map of options as the second argument to the `transform.ToMath` function. The options below are a subset of the KaTeX [rendering options].
|
||||
Pass a map of options as the second argument to the `transform.ToMath` function. The options below are a subset of the KaTeX [rendering options][].
|
||||
|
||||
displayMode
|
||||
: (`bool`) Whether to render in display mode instead of inline mode. Default is `false`.
|
||||
|
||||
errorColor
|
||||
: (`string`) The color of the error messages expressed as an RGB [hexadecimal color]. Default is `#cc0000`.
|
||||
: (`string`) The color of the error messages expressed as an RGB [hexadecimal color][]. Default is `#cc0000`.
|
||||
|
||||
fleqn
|
||||
: (`bool`) Whether to render flush left with a 2em left margin. Default is `false`.
|
||||
@@ -179,7 +179,7 @@ Step 4
|
||||
|
||||
{{< new-in 0.144.0 />}}
|
||||
|
||||
You can also use the `transform.ToMath` function to render chemical equations, leveraging the `\ce` and `\pu` functions from the [mhchem] package.
|
||||
You can also use the `transform.ToMath` function to render chemical equations, leveraging the `\ce` and `\pu` functions from the [`mhchem`][] package.
|
||||
|
||||
```text
|
||||
$$C_p[\ce{H2O(l)}] = \pu{75.3 J // mol K}$$
|
||||
@@ -187,10 +187,10 @@ $$C_p[\ce{H2O(l)}] = \pu{75.3 J // mol K}$$
|
||||
|
||||
$$C_p[\ce{H2O(l)}] = \pu{75.3 J // mol K}$$
|
||||
|
||||
[`Content`]: /methods/page/content/
|
||||
[`Summary`]: /methods/page/summary/
|
||||
[hexadecimal color]: https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color
|
||||
[KaTeX]: https://katex.org/
|
||||
[MathML]: https://developer.mozilla.org/en-US/docs/Web/MathML
|
||||
[mhchem]: https://mhchem.github.io/MathJax-mhchem/
|
||||
[`Content`]: /methods/page/content/
|
||||
[`Summary`]: /methods/page/summary/
|
||||
[`mhchem`]: https://mhchem.github.io/MathJax-mhchem/
|
||||
[hexadecimal color]: https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color
|
||||
[rendering options]: https://katex.org/docs/options.html
|
||||
|
||||
Reference in New Issue
Block a user