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

regex

A regular expression.

Can be used as a show rule selector and with string methods like find, split, and replace.

See here for a specification of the supported syntax.

Example

// Works with string methods.
#"a,b;c".split(regex("[,;]"))

// Works with show rules.
#show regex("\d+"): set text(red)

The numbers 1 to 10.
Preview

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

Create a regular expression from a string.

regex()->

regex
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 regular expression as a string.

Most regex escape sequences just work because they are not valid Typst escape sequences. To produce regex escape sequences that are also valid in Typst (e.g. \\), you need to escape twice. Thus, to match a verbatim backslash, you would need to write regex("\\\\").

If you need many escape sequences, you can also create a raw element and extract its text to use it for your regular expressions:

Show example

regex(`\d+\.\d+\.\d+`.text).

Open official docs

Search