Skip to main content
Module

x/lume/deps/katex.ts>KatexOptions

🔥 Static site generator for Deno 🦕
Very Popular
Latest
interface KatexOptions
import { type KatexOptions } from "https://deno.land/x/lume@v2.1.4/deps/katex.ts";

Properties

optional
displayMode: boolean | undefined

If true, math will be rendered in display mode (math in display style and center math on page)

If false, math will be rendered in inline mode

optional
output:
| "html"
| "mathml"
| "htmlAndMathml"
| undefined

Determines the markup language of the output. The valid choices are:

  • html: Outputs KaTeX in HTML only.
  • mathml: Outputs KaTeX in MathML only.
  • htmlAndMathml: Outputs HTML for visual rendering and includes MathML for accessibility.
optional
leqno: boolean | undefined

If true, display math has \tags rendered on the left instead of the right, like \usepackage[leqno]{amsmath} in LaTeX.

optional
fleqn: boolean | undefined

If true, display math renders flush left with a 2em left margin, like \documentclass[fleqn] in LaTeX with the amsmath package.

optional
throwOnError: boolean | undefined

If true, KaTeX will throw a ParseError when it encounters an unsupported command or invalid LaTex

If false, KaTeX will render unsupported commands as text, and render invalid LaTeX as its source code with hover text giving the error, in color given by errorColor

optional
errorColor: string | undefined

A Color string given in format #XXX or #XXXXXX

optional
macros: any

A collection of custom macros.

See src/macros.js for its usage

optional
minRuleThickness: number | undefined

Specifies a minimum thickness, in ems, for fraction lines, \sqrt top lines, {array} vertical lines, \hline, \hdashline, \underline, \overline, and the borders of \fbox, \boxed, and \fcolorbox.

optional
colorIsTextColor: boolean | undefined

If true, \color will work like LaTeX's \textcolor and takes 2 arguments

If false, \color will work like LaTeX's \color and takes 1 argument

In both cases, \textcolor works as in LaTeX

optional
maxSize: number | undefined

All user-specified sizes will be caped to maxSize ems

If set to Infinity, users can make elements and space arbitrarily large

optional
maxExpand: number | undefined

Limit the number of macro expansions to specified number

If set to Infinity, marco expander will try to fully expand as in LaTex

optional
strict:
| boolean
| string
| Function
| undefined

If false or "ignore", allow features that make writing in LaTex convenient but not supported by LaTex

If true or "error", throw an error for such transgressions

If "warn", warn about behavior via console.warn

optional
trust: boolean | ((context: TrustContext) => boolean) | undefined

If false (do not trust input), prevent any commands that could enable adverse behavior, rendering them instead in errorColor.

If true (trust input), allow all such commands.

optional
globalGroup: boolean | undefined

Place KaTeX code in the global group.

optional
delimiters: Delimiter[] | undefined

Auto-render specific options

optional
ignoredTags: string[] | undefined
optional
ignoredClasses: string[] | undefined
optional
preProcess: ((math: string) => string) | undefined