UQ Open Source Notes: Notes repository

Introduction

This repository is the main storage location for all notes found at the main notes website. The goal of this repository is to create well formed, up to date course notes for a variety of courses at UQ. This repository relies on contributions of students, so if you have content to share, please do!

Format

The notes in this repository are entirely written in Typst. Please review mathematical content and Typst syntax thoroughly before submitting changes.

Local Setup

1. Install Typst
2. Clone this repository
3. Compile any course using the --root flag so the template resolves correctly:

     typst compile --root . Science/SMP/MATH1061/main.typ

   The --root . flag sets the project root to the repo root, allowing lib.typ to be found via the /lib.typ import path used in each course.

Repository structure

Notes are organised as:

<Faculty>/<School>/<Course>/main.typ

Example: Science/SMP/MATH1061/main.typ

Adding a new course

Create a folder under the relevant faculty and school, e.g. Science/SMP/MATH1002/, with a main.typ that begins:

#import "/lib.typ": *

#show: notes.with(
  course: "MATH1002",
  title: "Your Course Title",
  year: "Semester 1, 2026",
  authors: ("Your Name",),
)

Then add chapter files and #include them from main.typ.

Contributing

To contribute, fork the repository and create a branch for your changes. Once done, submit a pull request with a clear description. We welcome contributions that improve the content, organisation, or formatting of the notes. Please ensure your changes are consistent with the overall style and do not introduce errors.

License

All content in this repository is licensed under the MIT License. You are free to use, modify, and distribute the content as long as you include the original copyright notice and license. See the LICENSE file for more information.