superTemplate

A Typst suite of macros for taking notes, doing problem sets, and writing reports in Mathematics, Computer Science, Physics, and Engineering. This package is best used as a companion to our other package.

Typst is required to use this package. You can get started by via the integrated language service Tinymist or by referring to Typst's installation page. Note that Tinymist currently supports VSCode, NeoVim, Emacs, Sublime Text, Helix, and Zed.

Features

This package is a set of namespaced macros for various subjects

The macros we have implemented are separated by subject to avoid naming conflicts and minimize the amount of overhead when importing. Many of the macros are inspired by their equivalents in Latex, which we were heavy users of prior to switching to Typst. In addition, commonly used Typst packages relevant to each subject are automatically imported. For example, we import the pseudocode package lovelace for our computer science module. The macros we implemented cover commonly used notation in the following topics:

• math_mod
  • linear algebra
  • real analysis (up to and including some measure theory)
  • group, ring, and field theory
  • topology
  • differential geometry
  • model theory
• cs_mod
  • cryptography
  • data structures and algorithms
  • programming language theory
  • formal language and automata theory
• physics_mod
  • quantum mechanics
  • quantum information
• pstat_mod
  • basic probability theory

Installation

1. Clone this repository somewhere locally on your machine.

2. cd into the repository and use the setup script in ./scripts to install. Note that the shell script only works if you are on Mac or Linux. If you are on Windows or would prefer to do this manually, refer to the Typst Packages repository for more information.

3. Test whether the installation worked by opening a new .typ file in any directory with the following code:

   #import "@local/superTemplate:0.3.0": *
   #import math_mod: *
   
   #cyc(1, 2, 3) Hello world!

   If you're able to render the pdf, you're good to go.