• 
• 
• Reference
• 
• Meta
• 
• Heading

headingElement

Element functions can be customized with set and show rules.

A section heading.

With headings, you can structure your document into sections. Each heading has a level, which starts at one and is unbounded upwards. This level indicates the logical role of the following content (section, subsection, etc.) A top-level heading indicates a top-level section of the document (not the document's title).

Typst can automatically number your headings for you. To enable numbering, specify how you want your headings to be numbered with a numbering pattern or function.

Independently from the numbering, Typst can also automatically generate an outline of all headings for you. To exclude one or more headings from this outline, you can set the outlined parameter to false.

Example

#set heading(numbering: "1.a)")

= Introduction
In recent years, ...

== Preliminaries
To start, ...

Syntax

Headings have dedicated syntax: They can be created by starting a line with one or multiple equals signs, followed by a space. The number of equals signs determines the heading's logical nesting depth.

Parameters

Parameters are the inputs to a function. They are specified in parentheses after the function name.

level

int

Settable

Settable parameters can be customized for all following uses of the function with a set rule.

The logical nesting depth of the heading, starting from one.

Default: 1

numbering

none or str or function

Settable

Settable parameters can be customized for all following uses of the function with a set rule.

How to number the heading. Accepts a numbering pattern or function.

Default: none

View example

#set heading(numbering: "1.a.")

= A section
== A subsection
=== A sub-subsection

supplement

none or auto or content or function

Settable

Settable parameters can be customized for all following uses of the function with a set rule.

A supplement for the heading.

For references to headings, this is added before the referenced number.

If a function is specified, it is passed the referenced heading and should return content.

Default: auto

View example

#set heading(numbering: "1.", supplement: [Chapter])

= Introduction <intro>
In @intro, we see how to turn
Sections into Chapters. And
in @intro[Part], it is done
manually.

outlined

bool

Settable

Settable parameters can be customized for all following uses of the function with a set rule.

Whether the heading should appear in the outline.

Note that this property, if set to true, ensures the heading is also shown as a bookmark in the exported PDF's outline (when exporting to PDF). To change that behavior, use the bookmarked property.

Default: true

View example

#outline()

#heading[Normal]
This is a normal heading.

#heading(outlined: false)[Hidden]
This heading does not appear
in the outline.

bookmarked

auto or bool

Settable

Settable parameters can be customized for all following uses of the function with a set rule.

Whether the heading should appear as a bookmark in the exported PDF's outline. Doesn't affect other export formats, such as PNG.

The default value of auto indicates that the heading will only appear in the exported PDF's outline if its outlined property is set to true, that is, if it would also be listed in Typst's outline. Setting this property to either true (bookmark) or false (don't bookmark) bypasses that behavior.

Default: auto

View example

#heading[Normal heading]
This heading will be shown in
the PDF's bookmark outline.

#heading(bookmarked: false)[Not bookmarked]
This heading won't be
bookmarked in the resulting
PDF.

body

content

RequiredPositional

Positional parameters are specified in order, without names.

The heading's title.

FootnotePrevious page

LabelNext page