transform.ToMath

January 1, 1

New in v0.132.0

參數

EXPRESSION: 使用 KaTeX 渲染的數學表達式。
OPTIONS: 一個包含零個或多個選項的映射。

選項

以下是 KaTeX 選項的一部分：

output

（string）。決定輸出的標記語言。可以是 html、mathml 或 htmlAndMathml。預設為 mathml。

若使用 html 或 htmlAndMathml，必須在基礎模板的 head 元素中包含 KaTeX 的 CSS。例如：

<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）若為 true，以展示模式渲染；否則以內聯模式渲染。預設為 false。

leqno

（bool）若為 true，將方程式編號置於左側。預設為 false。

fleqn

（bool）若為 true，將渲染靠左並留 2em 左邊距。預設為 false。

minRuleThickness

（float）分數線的最小厚度，以 em 為單位。預設為 0.04。

macros

（map）數學表達式中使用的巨集映射。預設為 {}。

throwOnError

（bool）若為 true，當 KaTeX 遇到不支援的指令或無效的 LaTeX 時拋出 ParseError。詳見錯誤處理。預設為 true。

errorColor

（string）錯誤訊息的顏色，以 RGB 十六進位色碼表示。預設為 #cc0000。

範例

基本用法

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

使用巨集

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

錯誤處理

KaTeX 提供 3 種錯誤處理方式：

讓 KaTeX 拋出錯誤並使建置失敗（預設行為）。
在模板中處理錯誤。參見下方的渲染掛載範例。
將 throwOnError 選項設為 false，讓 KaTeX 將表達式渲染為錯誤而非拋出錯誤。詳見選項。

layouts/_default/_markup/render-passthrough-inline.html

{{ with transform.ToMath .Inner }}
  {{ with .Err }}
    {{ errorf "Failed to render KaTeX: %q. See %s" . $.Position }}
  {{ else }}
    {{ . }}
  {{ end }}
{{ end }}
{{- /* 移除結尾換行符號 */ -}}