TypstDocumentation

outlineShowable
Question mark

A section outline / table of contents.

This function generates a list of all headings in the document, up to a given depth. The heading numbering will be reproduced within the outline.

Example

#outline()

= Introduction
#lorem(5)

= Prior work
#lorem(10)
Preview

Parameters
Question mark

title
noneautocontentSettable
Question mark

The title of the outline.

depth
noneintegerSettable
Question mark

The maximum depth up to which headings are included in the outline. When this argument is none, all headings are included.

indent
booleanSettable
Question mark

Whether to indent the subheadings to align the start of their numbering with the title of their parents. This will only have an effect if a heading numbering is set.

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

#outline(indent: true)

= About ACME Corp.

== History
#lorem(10)

== Products
#lorem(10)
Preview

fill
nonecontentSettable
Question mark

The symbol used to fill the space between the title and the page number. Can be set to none to disable filling. The default is a single dot.

#outline(
  fill: pad(x: -1.5pt)[]
)

= A New Beginning
Preview