{"route":"/en-US-v0.13.1/reference/model/heading/","title":"Heading","description":"Documentation for the `heading` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"syntax","name":"Syntax","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-level","name":"level","children":[]},{"id":"parameters-depth","name":"depth","children":[]},{"id":"parameters-offset","name":"offset","children":[]},{"id":"parameters-numbering","name":"numbering","children":[]},{"id":"parameters-supplement","name":"supplement","children":[]},{"id":"parameters-outlined","name":"outlined","children":[]},{"id":"parameters-bookmarked","name":"bookmarked","children":[]},{"id":"parameters-hanging-indent","name":"hanging-indent","children":[]},{"id":"parameters-body","name":"body","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"heading","title":"Heading","keywords":[],"oneliner":"A section heading.","element":true,"contextual":false,"deprecation":null,"details":"

A section heading.

\n

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

\n

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

\n

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

\n

Example

\n
#set heading(numbering: "1.a)")\n\n= Introduction\nIn recent years, ...\n\n== Preliminaries\nTo start, ...\n
\"Preview\"
\n

Syntax

\n

Headings have dedicated syntax: They can be created by starting a line with\none or multiple equals signs, followed by a space. The number of equals\nsigns determines the heading's logical nesting depth. The offset field\ncan be set to configure the starting depth.

","example":null,"self":false,"params":[{"name":"level","details":"

The absolute nesting depth of the heading, starting from one. If set\nto auto, it is computed from offset + depth.

\n

This is primarily useful for usage in show rules\n(either with where selectors or by accessing the\nlevel directly on a shown heading).

","example":"
#show heading.where(level: 2): set text(red)\n\n= Level 1\n== Level 2\n\n#set heading(offset: 1)\n= Also level 2\n== Level 3\n
\"Preview\"
","types":["auto","int"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"depth","details":"

The relative nesting depth of the heading, starting from one. This is\ncombined with offset to compute the actual level.

\n

This is set by the heading syntax, such that == Heading creates a\nheading with logical depth of 2, but actual level offset + 2. If you\nconstruct a heading manually, you should typically prefer this over\nsetting the absolute level.

","example":null,"types":["int"],"strings":[],"default":"1","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"offset","details":"

The starting offset of each heading's level, used to turn its\nrelative depth into its absolute level.

","example":"
= Level 1\n\n#set heading(offset: 1, numbering: "1.1")\n= Level 2\n\n#heading(offset: 2, depth: 2)[\n  I'm level 4\n]\n
\"Preview\"
","types":["int"],"strings":[],"default":"0","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"numbering","details":"

How to number the heading. Accepts a\nnumbering pattern or function.

","example":"
#set heading(numbering: "1.a.")\n\n= A section\n== A subsection\n=== A sub-subsection\n
\"Preview\"
","types":["none","str","function"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"supplement","details":"

A supplement for the heading.

\n

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

\n

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

","example":"
#set heading(numbering: "1.", supplement: [Chapter])\n\n= Introduction <intro>\nIn @intro, we see how to turn\nSections into Chapters. And\nin @intro[Part], it is done\nmanually.\n
\"Preview\"
","types":["none","auto","content","function"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"outlined","details":"

Whether the heading should appear in the outline.

\n

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

","example":"
#outline()\n\n#heading[Normal]\nThis is a normal heading.\n\n#heading(outlined: false)[Hidden]\nThis heading does not appear\nin the outline.\n
\"Preview\"
","types":["bool"],"strings":[],"default":"true","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"bookmarked","details":"

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

\n

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

","example":"
#heading[Normal heading]\nThis heading will be shown in\nthe PDF's bookmark outline.\n\n#heading(bookmarked: false)[Not bookmarked]\nThis heading won't be\nbookmarked in the resulting\nPDF.\n
\"Preview\"
","types":["auto","bool"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"hanging-indent","details":"

The indent all but the first line of a heading should have.

\n

The default value of auto indicates that the subsequent heading\nlines will be indented based on the width of the numbering.

","example":"
#set heading(numbering: "1.")\n#heading[A very, very, very, very, very, very long heading]\n
\"Preview\"
","types":["auto","length"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"body","details":"

The heading's title.

","example":null,"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["content"],"scope":[]}}}