All skills
apcamargo avatar

/typst-author

@433372a

Generate idiomatic Typst (.typ) code, edit and troubleshoot Typst documents and projects, and answer Typst syntax/reference questions. Use when working with .typ files or when the user explicitly asks for Typst document creation, editing, debugging, compilation, formatting, template work, or package usage.

Use this Skill: https://skilld.dev/gh/apcamargo/typst-skills/typst-author

This session only. Nothing lands on disk.

docsreferencelibrarymath.md

≈1.6k tokens on demand. Your agent reads this file only when SKILL.md points to it.

Math

Typst has special syntax and library functions to typeset mathematical formulas. Math formulas can be displayed inline with text or as separate blocks. They will be typeset into their own block if they start and end with at least one space (e.g. [$ x^2 $]).

Variables

In math, single letters are always displayed as is. Multiple letters, however, are interpreted as variables and functions. To display multiple letters verbatim, you can place them into quotes and to access single letter variables, you can use the hash syntax.

$ A = pi r^2 $
$ "area" = pi dot "radius"^2 $
$ cal(A) :=
    { x in RR | x "is natural" } $
#let x = 5
$ #x < 17 $

Symbols

Math mode makes a wide selection of symbols like pi, dot, or RR available. Many mathematical symbols are available in different variants. You can select between different variants by applying modifiers to the symbol. Typst further recognizes a number of shorthand sequences like => that approximate a symbol. When such a shorthand exists, the symbol's documentation lists it.

$ x < y => x gt.eq.not y $

Line Breaks

Formulas can also contain line breaks. Each line can contain one or multiple alignment points (&) which are then aligned.

$ sum_(k=0)^n k
    &= 1 + ... + n \
    &= (n(n+1)) / 2 $

Function calls

Math mode supports special function calls without the hash prefix. In these "math calls", the argument list works a little differently than in code:

  • Within them, Typst is still in "math mode". Thus, you can write math directly into them, but need to use hash syntax to pass code expressions (except for strings, which are available in the math syntax).

  • They support positional and named arguments, as well as argument spreading, but don't support trailing content blocks.

  • They provide additional syntax for 2-dimensional argument lists. The semicolon (;) merges preceding arguments separated by commas into an array argument.

$ frac(a^2, 2) $
$ vec(1, 2, delim: "[") $
$ mat(1, 2; 3, 4) $
$ mat(..#range(1, 5).chunks(2)) $
$ lim_x =
    op("lim", limits: #true)_x $

To write a verbatim comma or semicolon in a math call, escape it with a backslash. The colon on the other hand is only recognized in a special way if directly preceded by an identifier, so to display it verbatim in those cases, you can just insert a space before it.

Functions calls preceded by a hash are normal code function calls and not affected by these rules.

Alignment

When equations include multiple alignment points (&), this creates blocks of alternatingly right- and left-aligned columns. In the example below, the expression (3x + y) / 7 is right-aligned and = 9 is left-aligned. The word "given" is also left-aligned because && creates two alignment points in a row, alternating the alignment twice. & & and && behave exactly the same way. Meanwhile, "multiply by 7" is right-aligned because just one & precedes it. Each alignment point simply alternates between right-aligned/left-aligned.

$ (3x + y) / 7 &= 9 && "given" \
  3x + y &= 63 & "multiply by 7" \
  3x &= 63 - y && "subtract y" \
  x &= 21 - y/3 & "divide by 3" $

Math fonts

You can set the math font by with a show-set rule as demonstrated below. Note that only special OpenType math fonts are suitable for typesetting maths.

#show math.equation: set text(font: "Pennstander Math")
$ sum_(i in NN) 1 + i $

Math module

All math functions are part of the math module, which is available by default in equations. Outside of equations, they can be accessed with the math. prefix.

Accessibility

To make math accessible, you must provide alternative descriptions of equations in natural language using the alt parameter of math.equation. For more information, see the Textual Representations section of the Accessibility Guide.

#math.equation(
  alt: "d S equals delta q divided by T",
  block: true,
  $ dif S = (delta q) / T $,
)

In the future, Typst will automatically make equations without alternative descriptions accessible in HTML and PDF 2.0 export.

Variants

Alternate typefaces within formulas.

These functions are distinct from the text function because math fonts contain multiple variants of each letter.

Styles

Alternate letterforms within formulas.

These functions are distinct from the text function because math fonts contain multiple variants of each letter.

Sizes

Forced size styles for expressions within formulas.

These functions allow manual configuration of the size of equation elements to make them look as in a display/inline equation or as if used in a root or sub/superscripts.

Under/Over

Delimiters above or below parts of an equation.

The braces and brackets further allow you to add an optional annotation below or above themselves.

Roots

Square and non-square roots.

Example

$ sqrt(3 - 2 sqrt(2)) = sqrt(2) - 1 $
$ root(3, x) $

Attach

Subscript, superscripts, and limits.

Attachments can be displayed either as sub/superscripts, or limits. Typst automatically decides which is more suitable depending on the base, but you can also control this manually with the scripts and limits functions.

If you want the base to stretch to fit long top and bottom attachments (for example, an arrow with text above it), use the stretch function.

Example

$ sum_(i=0)^n a_i = 2^(1+i) $

Syntax

This function also has dedicated syntax for attachments after the base: Use the underscore (_) to indicate a subscript i.e. bottom attachment and the hat (^) to indicate a superscript i.e. top attachment.

Left/Right

Delimiter matching.

The lr function allows you to match two delimiters and scale them with the content they contain. While this also happens automatically for delimiters that match syntactically, lr allows you to match two arbitrary delimiters and control their size exactly. Apart from the lr function, Typst provides a few more functions that create delimiter pairings for absolute, ceiled, and floored values as well as norms.

To prevent a delimiter from being matched by Typst, and thus auto-scaled, escape it with a backslash. To instead disable auto-scaling completely, use {set math.lr(size: 1em)}.

Example

$ [a, b/2] $
$ lr(]sum_(x=1)^n], size: #50%) x $
$ abs((x + y) / 2) $
$ \{ (x / y) \} $
#set math.lr(size: 1em)
$ { (a / b), a, b in (0; 1/2] } $

Source: SKILL.md on GitHub

1 warning17d4 checks · Risk SAFE
  • Gen Agent Trust Hub17d

    The skill provides a comprehensive environment for generating, editing, and troubleshooting Typst documents. It relies on a local documentation set and standard Typst CLI tools for validation and formatting. No malicious patterns, obfuscation, or data exfiltration attempts were detected.

  • Socket17d

    No alerts

  • Snyk17d

    Risk: LOW · No issues

  • Runlayer7mo

    199/199 files flagged

Signed by skilld at 433372a. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 3 weeks ago.

Activeupdated 3 weeks ago

README badge

README badge for apcamargo/typst-skills/typst-author