https://github.com/jskherman/jsk-lecnotes
A lecture notes template in Typst.
https://github.com/jskherman/jsk-lecnotes
lecture-notes note-taking typst typst-template
Last synced: 8 months ago
JSON representation
A lecture notes template in Typst.
- Host: GitHub
- URL: https://github.com/jskherman/jsk-lecnotes
- Owner: jskherman
- License: apache-2.0
- Created: 2023-10-07T14:12:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-04T01:36:04.000Z (10 months ago)
- Last Synced: 2025-01-07T15:26:31.541Z (9 months ago)
- Topics: lecture-notes, note-taking, typst, typst-template
- Language: Typst
- Homepage:
- Size: 77.1 KB
- Stars: 39
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# README
This is a lecture notes template that uses Typst to generate a PDF document. This is based off of [Sara Venkatraman](https://github.com/sara-venkatraman)'s [lecture notes template in LaTeX](https://github.com/sara-venkatraman/LaTeX-Templates#lecture-notes).
There are some custom functions that are defined in the [`lib.typ`](./lib.typ) file that are used to add some markup. Additionally, here is [a link to Typst snippets files for VS Code and Vim/Neovim](https://www.jskherman.com/blog/typst-snippets/) converted from [Gilles Castel's LaTeX snippets](https://castel.dev/post/lecture-notes-1/) to make writing math in Typst more convenient.
## Preview
See [example PDF](https://github.com/jskherman/jsk-lecnotes/releases/latest/download/example.pdf) in the Releases section.
## Usage
1. Download a copy of the [`lib.typ`](./lib.typ) file and [`example.typ`](./example.typ).
2. Copy these files to your project's root directory.
3. Rename `example.typ` to `main.typ` and customize it 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 "/lib.typ": *` to the top of each file for certain functions to work such as `blockquote()` or `iboxed()`.
>
> For example, assuming you have a `/content/chapter1.typ` file and a `/lib.typ` file at the project root, you would need to add `#import "/lib.typ": *` to the top of the chapter file.