Typst Fumadocs

Attach

Documentation for the `attach` function.

A file that will be attached to the output PDF.

This can be used to distribute additional files associated with the PDF within it. PDF readers will display the files in a file listing.

Some international standards use this mechanism to attach machine-readable data (e.g., ZUGFeRD/Factur-X for invoices) that mirrors the visual content of the PDF.

Example

#pdf.attach(
  "experiment.csv",
  relationship: "supplement",
  mime-type: "text/csv",
  description: "Raw Oxygen readings from the Arctic experiment",
)

Notes

  • This element is ignored if exporting to a format other than PDF.
  • File attachments are not currently supported for PDF/A-2, even if the attached file conforms to PDF/A-1 or PDF/A-2.
#pdf.attach(
  path,
  data,
  relationship: none | str,
  mime-type: none | str,
  description: none | str
) -> content

Parameters

Prop

Type

On this page