feat: add lecture notes Typst template v0.1.0

This commit is contained in:
Popa committed 2026-10-30 19:45:43 +01:00
1 parent 4664df1af3
commit e6a09ef7c3
10 files changed
+581

No files matched your search

+211
View File
@@ -0,0 +1,211 @@
#import "theme.typ": theme-state
#let _box(body, color, header: none, breakable: false) = {
let thickness = 0.5pt
let background = color.transparentize(90%)
let accent = (paint: color, thickness: thickness * 4)
let border = (paint: color.transparentize(50%), thickness: thickness)
set enum(numbering: "(i)")
block(
width: 100%,
inset: 0pt,
stroke: (x: border),
breakable: breakable,
fill: if header == none { background },
)[
#block(outset: (x: thickness / 2), width: 100%, stroke: (top: accent), sticky: true)
#if header != none {
block(
width: 100%,
fill: background,
inset: (x: 12pt, y: 8pt),
above: 0pt,
below: 0pt,
sticky: true,
)[#header]
}
#block(
width: 100%,
inset: (x: 12pt, top: 8pt, bottom: if header != none { 12pt } else { 8pt }),
above: 0pt,
below: 0pt,
)[#body]
#block(outset: (x: thickness / 2), width: 100%, stroke: (bottom: border))
]
}
#let _statement(kind, body, color, label: none, inline: false, breakable: true) = context {
let headings = counter(heading).get()
let first = if headings.len() >= 1 { calc.max(1, headings.at(0)) } else { 1 }
let second = if headings.len() >= 2 { calc.max(1, headings.at(1)) } else { 1 }
let statement = counter("lecture-notes.statement-" + str(first) + "-" + str(second))
let suffix = if label != none { [ (#label)] }
statement.step()
context {
let mark = statement.display(number => numbering("1.1.1", first, second, number))
let heading = text(
font: theme-state.get().text.sans-font,
weight: 600,
size: 0.9em,
fill: color.darken(20%),
)[#kind #mark#suffix.]
if inline {
_box([#heading #body], color.darken(20%), breakable: false)
} else {
_box(body, color.darken(20%), header: heading, breakable: breakable)
}
}
}
#let statement-names = (
en: (
definition: [Definition],
axiom: [Axiom],
theorem: [Theorem],
lemma: [Lemma],
corollary: [Corollary],
),
de: (
definition: [Definition],
axiom: [Axiom],
theorem: [Satz],
lemma: [Lemma],
corollary: [Korollar],
),
)
#let _statement-name(kind, lang) = statement-names.at(lang, default: statement-names.en).at(kind)
#let definition(body, label: none, inline: false, breakable: true, lang: none) = context {
let lang = if lang == none { theme-state.get().text.lang } else { lang }
_statement(
_statement-name("definition", lang),
body,
theme-state.get().statement-colors.definition,
label: label,
inline: inline,
breakable: breakable,
)
}
#let axiom(body, label: none, inline: false, breakable: true, lang: none) = context {
let lang = if lang == none { theme-state.get().text.lang } else { lang }
_statement(
_statement-name("axiom", lang),
body,
theme-state.get().statement-colors.axiom,
label: label,
inline: inline,
breakable: breakable,
)
}
#let theorem(body, label: none, inline: false, breakable: true, lang: none) = context {
let lang = if lang == none { theme-state.get().text.lang } else { lang }
_statement(
_statement-name("theorem", lang),
body,
theme-state.get().statement-colors.theorem,
label: label,
inline: inline,
breakable: breakable,
)
}
#let lemma(body, label: none, inline: false, breakable: true, lang: none) = context {
let lang = if lang == none { theme-state.get().text.lang } else { lang }
_statement(
_statement-name("lemma", lang),
body,
theme-state.get().statement-colors.lemma,
label: label,
inline: inline,
breakable: breakable,
)
}
#let corollary(body, label: none, inline: false, breakable: true, lang: none) = context {
let lang = if lang == none { theme-state.get().text.lang } else { lang }
_statement(
_statement-name("corollary", lang),
body,
theme-state.get().statement-colors.corollary,
label: label,
inline: inline,
breakable: breakable,
)
}
#let satz(..args) = theorem(..args, lang: "de")
#let korollar(..args) = corollary(..args, lang: "de")
#let def = definition
#let thm = theorem
#let cor = corollary
#let kor = korollar
#let exercise(
body,
heading: [],
points: [],
color: none,
stroke-color: none,
text-color: none,
radius: 5pt,
) = context {
let theme = theme-state.get()
let color = if color != none { color } else { theme.colors.accent }
let stroke-color = if stroke-color != none { stroke-color } else { theme.colors.stroke }
let text-color = if text-color != none { text-color } else { theme.colors.text }
let background = color.lighten(95%)
let label-box = content => block(
fill: white,
stroke: stroke-color + 0.4pt,
radius: radius * 0.75,
inset: 5pt,
text(text-color, content),
)
let head = if heading != [] or points != [] {
if heading != [] {
let badge = label-box(heading)
place(dy: -measure(badge).height / 2 - 12pt, badge)
}
if points != [] {
let badge = label-box(points)
place(dy: -measure(badge).height / 2 - 12pt, box(width: 100%, align(right)[#badge]))
}
v(0.5em)
} else { [] }
if head != [] { v(1em) }
block(
fill: background,
stroke: (
left: color + 1.7pt,
top: stroke-color + 0.4pt,
right: stroke-color + 0.6pt,
bottom: stroke-color + 0.6pt,
),
width: 100%,
radius: radius,
inset: 12pt,
above: 12pt,
below: 18pt,
)[
#set enum(numbering: "(i)")
#head
#body
]
}
+41
View File
@@ -0,0 +1,41 @@
#import "@local/lecture-notes:0.1.0": *
#show: lecture-notes.with(seminar: [Algebra I])
#title-page(
title: [Inoffizielles Skript zur Vorlesung \ Algebra I],
authors: ([Zusammengestellt von #smallcaps[Maximilian Mustermann]],),
university: [#smallcaps[Prof. Dr. Bianca Beispiel]
#v(1.5em)
#text(size: 12pt)[Wintersemester 2026/27]
#v(0pt)
Beispieluniversität],
location: [Musterstadt],
)
#set page(numbering: "i")
#outline()
#counter(heading).update(0) // prevent the outline heading from being counted aswell
#pagebreak(weak: true)
#set page(numbering: "1")
#counter(page).update(1)
#lecture("19.10.2026", title: [Einführung in Gruppentheorie])
= Gruppen
== Definitionen
#definition[
Eine _Gruppe_ ist ein Monoid, in dem jedes Element ein Inverses besitzt.
]
#theorem(label: [Eindeutigkeit], inline: true)[
Das inverse Element ist eindeutig.
]
Ein kurzer Beweis endet so.#footnote[Anmerkung: Dies ist eine Fußnote.] #qed
#pagebreak()
Fortsetzung der ersten Vorlesung mit automatischer Kopfzeile.
+26
View File
@@ -0,0 +1,26 @@
#let render-footnote-entry(entry, numbering-pattern: "[1]") = {
let loc = entry.note.location()
let mark = numbering(numbering-pattern + ":", ..counter(footnote).at(loc))
pad(left: entry.indent)[
#grid(
columns: (auto, 1fr),
gutter: 0.3em,
mark, entry.note.body,
)
]
}
#let _qed = $square$
#let qed-equation(eq) = {
set math.equation(numbering: _ => _qed, number-align: right + bottom)
eq
}
#let qed = [#h(1fr)#_qed]
#let Im = math.op("Im")
#let Re = math.op("Re")
#let ü = text(font: "Fira Sans", size: 0.85em, weight: 600)[[Ü]]
#let ord = math.op("ord")
+18
View File
@@ -0,0 +1,18 @@
#let lecture-counter = counter("lecture-notes.lecture")
#let reset-lectures() = lecture-counter.update(0)
#let lecture(date, title: none, prefix: [Vorlesung]) = {
lecture-counter.step()
context {
let number = lecture-counter.get().first()
[#metadata((number: number, date: date, title: title, prefix: prefix)) <lecture-notes-lecture>]
block(width: 100%, above: 1.5em, below: 1.5em)[
#if number > 1 { divider() }
#prefix #number, #date#if title != none [ -- #title]
]
}
}
+6
View File
@@ -0,0 +1,6 @@
#import "theme.typ": default-theme, theme-state
#import "style.typ": lecture-notes
#import "title-page.typ": title-page
#import "lecture.typ": lecture, lecture-counter, reset-lectures
#import "boxes.typ": *
#import "helpers.typ": Im, Re, ord, qed, qed-equation, render-footnote-entry, ü
+105
View File
@@ -0,0 +1,105 @@
#import "helpers.typ": render-footnote-entry
#import "theme.typ": default-theme, resolve-theme, theme-state
#let lecture-notes(
seminar: none,
theme: (:),
show-header: true,
body,
) = {
let active-theme = resolve-theme(theme)
theme-state.update(active-theme)
set page(
margin: (x: 2.5cm),
numbering: "1",
header: context {
if show-header {
let page-number = here().page()
let lectures = query(<lecture-notes-lecture>).filter(
lecture => lecture.location().page() < page-number,
)
if lectures.len() > 0 {
let current = lectures.last().value
set text(size: 0.8em)
grid(
columns: (1fr, 2fr, 1fr),
align: (start, center, end),
if seminar == none { [] } else { [*#seminar*] },
[#current.prefix #current.number#if current.title != none [: #current.title]],
text(fill: active-theme.colors.text)[#current.date],
)
}
}
},
)
set text(
lang: active-theme.text.lang,
font: active-theme.text.text-font,
)
show math.equation: set text(font: active-theme.text.math-font)
show heading.where(level: 1): it => context {
set text(
size: 1.25em,
font: theme-state.get().text.sans-font,
weight: 700,
fill: theme-state.get().colors.text,
)
if it.numbering == none {
counter(heading).step(level: 1)
}
line(length: 100%, stroke: 0.5pt + theme-state.get().colors.stroke)
v(-0.55em)
align(center, it)
v(-0.5em)
line(length: 100%, stroke: 0.5pt + theme-state.get().colors.stroke)
v(0.5em)
}
show heading.where(level: 2): it => context {
set text(
size: 1.15em,
font: theme-state.get().text.sans-font,
weight: 700,
fill: theme-state.get().colors.text,
)
if it.numbering == none {
counter(heading).step(level: 2)
}
align(center, underline(
background: true,
evade: false,
stroke: 4pt + theme-state.get().colors.stroke,
offset: 3pt,
it,
))
v(0.25em)
}
set par(justify: active-theme.text.justify)
show divider: set align(center)
show divider: block(text(fill: active-theme.colors.text)[\u{2217} \u{2217} \u{2217}])
set footnote(numbering: "[1]")
set footnote.entry(
separator: line(
length: 30% + 0pt,
stroke: active-theme.colors.primary.lighten(50%) + 0.5pt,
),
indent: 1em,
)
show footnote.entry: it => render-footnote-entry(it, numbering-pattern: "[1]")
show "\u{00A0}": sym.space.nobreak.narrow
body
}
+45
View File
@@ -0,0 +1,45 @@
#let default-theme = (
text: (
lang: "de",
text-font: "TeX Gyre Termes",
sans-font: "Fira Sans",
math-font: "TeX Gyre Termes Math",
justify: true,
),
colors: (
primary: eastern,
accent: aqua,
text: eastern.darken(40%),
stroke: eastern.lighten(50%),
code-border: gray,
code-inline-border: rgb("CCCCCC"),
code-block-fill: luma(98.75%),
code-inline-fill: luma(96%),
),
statement-colors: (
definition: eastern,
axiom: orange,
theorem: blue,
lemma: aqua,
corollary: purple,
),
)
#let theme-state = state("lecture-notes.theme", default-theme)
#let resolve-theme(theme) = {
let result = default-theme
for (key, value) in result {
let override = theme.at(key, default: none)
if override != none {
result.at(key) = if type(value) == dictionary and type(override) == dictionary {
value + override
} else {
override
}
}
}
result
}
+81
View File
@@ -0,0 +1,81 @@
#let _author-name(author) = if type(author) == dictionary {
author.at("name", default: [])
} else {
author
}
#let _display-date(date, format) = if type(date) == datetime {
date.display(format)
} else if type(date) == array and date.len() == 2 {
date.first().display(format) + [ -- ] + date.last().display(format)
} else {
date
}
#let title-page(
title: none,
subtitle: none,
authors: (),
date: datetime.today(),
university: none,
location: none,
date-label: [Stand:],
date-format: "[day].[month].[year]",
language: "de",
page-grid: 13.6pt,
title-color: luma(80),
break-after: true,
reset-page-counter: true,
) = {
let authors = if type(authors) == array { authors } else { (authors,) }
let many-authors = authors.len() > 1
set page(numbering: none)
set text(lang: language, size: page-grid)
set align(center)
v(7 * page-grid)
text(weight: "bold", fill: title-color, size: 1.75 * page-grid, title)
v(0.25 * page-grid)
if subtitle != none {
text(fill: title-color, size: page-grid, subtitle)
}
v(page-grid)
if university != none {
[#university#if location != none [ #location]]
}
if authors.len() > 0 {
place(
bottom + center,
dy: -10 * page-grid,
grid(
columns: 100%,
gutter: if many-authors { 14pt } else { 1.25 * page-grid },
..authors.map(author => align(center, text(_author-name(author)))),
),
)
}
set text(size: 11pt)
place(
bottom + center,
grid(
columns: (auto, auto),
row-gutter: 1em,
column-gutter: 1em,
align: (right, left),
text(weight: "bold", fill: title-color, date-label), text(_display-date(date, date-format)),
),
)
if break-after {
pagebreak(weak: true)
if reset-page-counter {
counter(page).update(1)
}
}
}
+7
View File
@@ -0,0 +1,7 @@
[package]
name = "lecture-notes"
version = "0.1.0"
entrypoint = "lib.typ"
authors = ["Popa"]
description = "A Typst template for mathematical lecture notes."
compiler = "0.15.1"
+41
View File
@@ -0,0 +1,41 @@
# lecture-notes
A Typst template for mathematical lecture notes.
```typst
#import "@local/lecture-notes:0.1.0": *
#show: lecture-notes.with(seminar: [Algebra I])
#title-page(
title: [Lecture Notes: \ Algebra I],
authors: ([#smallcaps[John Doe]],),
university: [#smallcaps[Prof. Jane Q. Smith] #v(1.5em)
#text(size: 12pt)[Winter 2026/27] #v(0pt) Example University],
location: [City, Country],
)
#lecture("27/10/2026", title: [Introduction to group theory])
= Group Theory
#definition[
A group is a monoid such that every element has an inverse.
]
```
Style can be partially overridden:
```typst
#show: lecture-notes.with(
seminar: [Algebra I],
theme: (
text: (justify: false,),
colors: (primary: teal,),
),
)
```
The package contains the following components: `lecture-notes`, `title-page`, `lecture`, `definition`, `axiom`, `theorem`, `lemma`, `corollary`, `exercise`, `qed`, `qed-equation`, `Im`, `Re` and `ord`.
`def`, `thm`, `satz`, `kor` and `korollar` stay for backwards compatibility.