Simple Report Template (Typst)

A minimal, reusable Typst template for writing simple two-column reports.

This repository is designed to be beginner-friendly. If you are new to Typst, start with the quick start below and the linked tutorials.

Project Structure

• src/configuration.typ: template style and layout configuration
• src/report.typ: ready-to-edit report source
• examples/basic-report.typ: extra sample report using the same template

Quick Start

1. Install Typst

Pick one option:

• Typst Web App (no local install): https://typst.app
• Typst CLI install guide: https://github.com/typst/typst?tab=readme-ov-file#installation

2. Compile the report

From this folder, run:

mkdir -p build
typst compile src/report.typ build/report.pdf

Or compile the sample in examples:

typst compile --root . examples/basic-report.typ build/basic-report.pdf

Generated PDFs are build artifacts. This repository ignores *.pdf via .gitignore.

3. Edit content

Open src/report.typ and update:

• document title
• authors list
• abstract
• section content

Reuse This Template In Another Project

Copy these files into your new report folder:

• src/configuration.typ
• one source file (for example src/report.typ)

Then keep a local import in your source file:

#import "./src/configuration.typ": configuration

Template API

The template exposes:

#show: configuration.with(
  authors: (
    (
      name: "First Author",
      affiliation: "Affiliation 1",
      email: "first.author@example.org",
    ),
  ),
  abstract: "Short abstract text",
)

• authors: tuple of author objects (name, affiliation, email)
• abstract: abstract content (text or rich Typst content)

Learn Typst

If you are new, start here in this order:

1. Tutorial: https://typst.app/docs/tutorial/
2. Full documentation: https://typst.app/docs/
3. Reference pages (functions, styling, layout): https://typst.app/docs/reference/
4. Community packages and examples: https://typst.app/universe/

License

This project uses the MIT License. See LICENSE.