hugo/content/en/functions/transform/ToMath.md at dec8cd4ada29218971743333f8ac662a9c06aad8

blogs/hugo

mirror of https://github.com/gohugoio/hugo.git synced 2026-08-24 23:38:53 +00:00

Files

T

Bjørn Erik Pedersen dec8cd4ada Squashed 'docs/' changes from fcc3ed651..a49697e53

a49697e53 Add private use subtag requirements to multilingual page
a5c6bb4da Add INFINI Pizza search engine
45b732efa Fix template lookup order for AMP pages
30c672d0b netlify: Hugo 0.133.1
7c766e724 Update page resources documentation
ca802fbec Document how to enable AsciiDoc syntax highlighting
c3350f4cf Update definition of falsy to include zero time.Time values
b0e5ab051 Fir typo
60f6cb63b Update migrations.md
ec52c7ba1 Improve formatting of example code
e5681ad01 Improve formatting of example code
bdf3ffc73 Clarify the various next/prev methods
b5505d22a Clarify template lookup order for shortcodes
cf8dd7034 Improve embedded.md
e5dee2651 Update transform.ToMath
4d419a128 Update pagination configuration to use new struct
05d4fd597 Update PrevInSection.md
fd33370ed Add new-in 0.133.0
f9062042f Add the new page config section
205645e97 Remove out-dated  new-in
3ed3673f7 Fix typo
41df91659 Document the 'else with' construct introduced with Go 1.23
9c4697ab3 netlify: Hugo 0.133.0
62506b052 Merge branch 'temp133'
877e1bfcd Add config options page.nextPrevSortOrder/nextPrevInSectionSortOrder
eb159fe62 Update menu.md
efa7795a0 Update theme
dbe8911ad netlify: Hugo 0.132.2
2f793d328 Document passthrough render hooks
a7ce9a5e8 netlify: Hugo 0.132.1
2c137cb48 Update blockquotes.md
e0fa2f0d1 Add new-in badge to blockquote render hook page
bf42bbe6b Update references to render hooks
85a3d9958 Update theme
2dae72128 Document blockquote render hooks
8f5afb55d Update plainify return type
160f22d0e netlify: Hugo 0.132.0
82b5586fb Document transform.ToMath
1efcbcddb tpl/transform: Make Plainify and ToMath return template.HTML
31727be2e docs: Regen docshelper
88a421426 Merge commit 'a6e635ca7d905d9ec3ffd708db2694f680b03aae'

git-subtree-dir: docs
git-subtree-split: a49697e536

2024-09-01 14:51:15 +02:00

3.3 KiB

Raw Blame History

title, description, categories, keywords, action, aliases, toc

title

description

Arguments

EXPRESSION: The math expression to render using KaTeX.
OPTIONS: A map of zero or more options.

Options

These are a subset of the KaTeX options.

output

(string). Determines the markup language of the output. One of html, mathml, or htmlAndMathml. Default is mathml.

With html and htmlAndMathml you must include KaTeX CSS within the head element of your base template. For example:

<head>
  ...
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.css" integrity="sha384-nB0miv6/jRmo5UMMR1wu3Gz6NLsoTkbqJghGIsx//Rlm+ZU03BU6SQNC66uf4l5+" crossorigin="anonymous">
  ...
</head>

displayMode

(bool) If true render in display mode, else render in inline mode. Default is false.

leqno

(bool) If true render with the equation numbers on the left. Default is false.

fleqn

(bool) If true render flush left with a 2em left margin. Default is false.

minRuleThickness

(float) The minimum thickness of the fraction lines in em. Default is 0.04.

macros

(map) A map of macros to be used in the math expression. Default is {}.

throwOnError

(bool) If true throw a ParseError when KaTeX encounters an unsupported command or invalid LaTex. See error handling. Default is true.

errorColor

(string) The color of the error messages expressed as an RGB hexadecimal color. Default is #cc0000.

Examples

Basic

{{ transform.ToMath "c = \\pm\\sqrt{a^2 + b^2}" }}

Macros

{{ $macros := dict 
    "\\addBar" "\\bar{#1}"
    "\\bold" "\\mathbf{#1}"
}}
{{ $opts := dict "macros" $macros }}
{{ transform.ToMath "\\addBar{y} + \\bold{H}" $opts }}

Error handling

There are 3 ways to handle errors from KaTeX:

Let KaTeX throw an error and make the build fail. This is the default behavior.
Handle the error in your template. See the render hook example below.
Set the throwOnError option to false to make KaTeX render the expression as an error instead of throwing an error. See [options].

{{< code file=layouts/_default/_markup/render-passthrough-inline.html copy=true >}} {{ with transform.ToMath .Inner }} {{ with .Err }} {{ errorf "Failed to render KaTeX: %q. See %s" . $.Position }} {{ else }} {{ . }} {{ end }} {{ end }} {{- /* chomp trailing newline */ -}} {{< /code >}}

3.3 KiB Raw Blame History