Info
This site is generated using the static site generator developed by the Typst Community. Please adjust the text content of this banner according to your usage requirements. At Typst GmbH's request, when publishing documentation, you must clearly indicate that it is non-official and display the version of Typst being documented. For details, refer to Issue #874 on typst/typst.
TypstDocumentEnglish
v0.dev.2025-09-12

sub
Element
Element
Element functions can be customized with set and show rules.

Renders text in subscript.

The text is rendered smaller and its baseline is lowered.

Example

Revenue#sub[yearly]
Preview

Parameter
Parameter
Parameters are input values for functions. Specify them in parentheses after the function name.

typographic
Settable
Settable
Settable parameters can be set using the set rule, changing the default value used thereafter.

Whether to use subscript glyphs from the font if available.

Ideally, subscripts glyphs are provided by the font (using the subs OpenType feature). Otherwise, Typst is able to synthesize subscripts by lowering and scaling down regular glyphs.

When this is set to false, synthesized glyphs will be used regardless of whether the font provides dedicated subscript glyphs. When true, synthesized glyphs may still be used in case the font does not provide the necessary subscript glyphs.

Default value:

true

Show example
N#sub(typographic: true)[1]
N#sub(typographic: false)[1]
Preview

baseline
Settable
Settable
Settable parameters can be set using the set rule, changing the default value used thereafter.

The downward baseline shift for synthesized subscripts.

This only applies to synthesized subscripts. In other words, this has no effect if typographic is true and the font provides the necessary subscript glyphs.

If set to auto, the baseline is shifted according to the metrics provided by the font, with a fallback to 0.2em in case the font does not define the necessary metrics.

Default value:

auto

size
Settable
Settable
Settable parameters can be set using the set rule, changing the default value used thereafter.

The font size for synthesized subscripts.

This only applies to synthesized subscripts. In other words, this has no effect if typographic is true and the font provides the necessary subscript glyphs.

If set to auto, the size is scaled according to the metrics provided by the font, with a fallback to 0.6em in case the font does not define the necessary metrics.

Default value:

auto

body
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

The text to display in subscript.

Open official docs

Search