TypstDocumentation

documentElement
Question mark

The root element of a document and its metadata.

All documents are automatically wrapped in a document element. You cannot create a document element yourself. This function is only used with set rules to specify document metadata. Such a set rule must appear before any of the document's contents.

#set document(title: [Hello])

This has no visible output, but
embeds metadata into the PDF!
Preview

Note that metadata set with this function is not rendered within the document. Instead, it is embedded in the compiled PDF file.

Parameters
Question mark

title
none or content
Settable
Question mark

The document's title. This is often rendered as the title of the PDF viewer window.

While this can be arbitrary content, PDF viewers only support plain text titles, so the conversion might be lossy.

Default: none

author
str or array
Settable
Question mark

The document's authors.

Default: ()

keywords
str or array
Settable
Question mark

The document's keywords.

Default: ()

date
none or auto or datetime
Settable
Question mark

The document's creation date.

If this is auto (default), Typst uses the current date and time. Setting it to none prevents Typst from embedding any creation date into the PDF metadata.

The year component must be at least zero in order to be embedded into a PDF.

Default: auto