README

This is a lecture notes template that uses Typst to generate a PDF document. This is based off of Sara Venkatraman's lecture notes template in LaTeX.

There are some custom functions that are defined in the template.typ file that are used to add some markup. Additionally, here is a link to Typst snippets files for VS Code and Vim/Neovim converted from Gilles Castel's LaTeX snippets to make writing math in Typst more convenient.

Preview

See example PDF in the Releases section.

Usage

1. Download a copy of the template.typ file and example.typ.
2. Copy these files to your project's root directory.
3. Rename and customize the example.typ file to get started using the template.

Notes

Warning

If you plan to split your document into multiple files for organization, you may need to add #import "template.typ": * to the top of each file for certain functions to work such as blockquote() or iboxed().

For example, assuming you have a ./content/chapter.typ file and a ./template.typ file at the project root, you would need to add #import "../template.typ": * to the top of the file.