Skip to content

minimal-thesis-luebeck:0.8.0 #2882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions packages/preview/minimal-thesis-luebeck/0.8.0/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Falko Hemstra

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
44 changes: 44 additions & 0 deletions packages/preview/minimal-thesis-luebeck/0.8.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# minimal thesis template

This repo contains a minimalistic template for writing a thesis.
The main objective of the template is to produce a nice document with as little code as possible. No nonsense, no extras.

While this is **not** an official template for the "Universität zu Lübeck", it is loosely inspired by its official LaTeX template by Till Tantau.
The official LaTeX template is a lot prettier.
However, it is also more code.

To be clear: Using this template does not guarantee any compliance with university standards.
Consult your advisor for tips and rules on writing a thesis.

## Installation

### Typst web application

Just select this template by its name and version and start writing!

### Typst CLI (local)

In your CLI, navigate to your empty project directory and use `typst init @preview/minimal-thesis-luebeck:0.8.0`.
I recommend using VS Code and the [tinymist extension](https://github.com/Myriad-Dreamin/tinymist) for working with a local installation.

## Usage

When installed, this template provides you with a `thesis.typ` file.
This is where you write your thesis.

Note that by default this template is configured to write thesis using english language in a german environment. However, you can exchange all strings in the template to match your preferred languages.

_Hint_: You can take a look at `tutorial.typ` if you are new to Typst.

## Template Contents
- **thesis.typ**: The central document that finally produces your PDF document. Initially, this includes `tutorial.typ` to give some examples. Just remove the tutorial when you start working.
- **thesis.bib**: The bibliography. Put your references here.
- **texts**: Contains texts that are separate from your main thesis such as the abstract. If you like, you can also put chapters of your thesis here. Personally however, I like having everything in one place.
- **images**: Contains all images. You should replace the example images with your own. Also, you might need to adjust some sizes afterwards (`config/titlepage.typ`).

## Credits

This template is inspired by this one: [thesis-template-typst
](https://github.com/ls1intum/thesis-template-typst?tab=MIT-1-ov-file#readme)

The example image of a cat was generated using OpenAI's DALL-E.
3 changes: 3 additions & 0 deletions packages/preview/minimal-thesis-luebeck/0.8.0/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
1. Increment version in `typst.toml`
2. Change `include` in `thesis.typ` to use new version
3. Update version in `README.md`
14 changes: 14 additions & 0 deletions packages/preview/minimal-thesis-luebeck/0.8.0/styles/abstract.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#let abstract(
title: "Abstract",
dark-color: black,
body
) = {
set par(
leading: 1em,
justify: true
)

heading(title, outlined: false, level: 2)

body
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#let acknowledgement(
dark-color: black,
body
) = {
set page(
margin: (left: 30mm, right: 30mm, top: 40mm, bottom: 40mm),
number-align: center,
)

set par(
leading: 1em,
justify: true
)

// --- Acknowledgements ---
context {
let lang = text.lang
if lang == "de" {
heading("Danksagung", outlined: false, level: 2)
} else {
heading("Acknowledgements", outlined: false, level: 2)
}
}

body
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#let disclaimer(
author,
body
) = {
set page(
margin: (left: 30mm, right: 30mm, top: 40mm, bottom: 40mm),
numbering: "i",
number-align: center,
)

// --- Disclaimer ---
v(65%)

body

parbreak()
v(10%)
line(length: 35%)
emph(author)
}
76 changes: 76 additions & 0 deletions packages/preview/minimal-thesis-luebeck/0.8.0/styles/titlepage.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
#let titlepage(
top-left-img: none,
top-right-img: none,
title-english: none,
title-german: none,
degree: none,
institute: none,
program: none,
university: none,
company: none,
author: none,
supervisor: none,
advisor: none,
place: none,
submission-date: none,
slogan-img: none,
dark-color: black,
light-color: gray,
sans-font: none
) = {
set page(
margin: (left: 20mm, right: 20mm, top: 20mm, bottom: 30mm),
footer: none
)
set text(
font: sans-font,
size: 11pt
)
set par(leading: 0.5em)

// --- Title Page ---
grid(
columns: (4cm, 4cm),
gutter: 1fr,
top-left-img,
top-right-img
)
v(10mm)

context {
let lang = text.lang
if lang == "de" {
align(left, text(16pt, strong(title-german), fill: dark-color))
align(left, text(16pt, title-english, fill: dark-color))
align(left, text(weight: "bold", degree + "arbeit"))
} else {
align(left, text(16pt, strong(title-english), fill: dark-color))
align(left, text(16pt, title-german, fill: dark-color))
align(left, text(weight: "bold", degree + "’s Thesis"))
}

}

align(left, "verfasst am\n" + strong(institute))

align(left, "im Rahmen des Studiengangs\n" + strong(program) + "\nder " + university)

if company != none {
align(left, "im Rahmen einer Tätigkeit bei der Firma\n" + strong(company))
}

align(left, "vorgelegt von\n" + strong(author))

align(left, "ausgegeben und betreut von\n" + strong(supervisor))

align(left, "mit Unterstützung von\n" + strong(advisor))

align(bottom,
grid(
columns: (5cm, 3.5cm),
gutter: 1fr,
place + ", den " + submission-date.display("[day].[month].[year]"),
slogan-img
)
)
}
32 changes: 32 additions & 0 deletions packages/preview/minimal-thesis-luebeck/0.8.0/styles/toc.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// --- Table of Contents ---
#let toc(
body-font: "",
sans-font: "",
dark-color: black
) = {
// Make chapters bold but only in the TOC
show outline.entry.where(
level: 1
): it => {
v(12pt, weak: true)
strong(text(it, font: sans-font, fill: dark-color))
}

context {
let lang = text.lang
let title_str = ""
if lang == "de" {
title_str = "Inhaltsverzeichnis"
} else {
title_str = "Contents"
}
// Set the title of the TOC
outline(
title: {
text(font: sans-font, title_str, size: 15pt)
},
indent: 2em
)
}

}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#import "@preview/abbr:0.2.3"

#abbr.make(
("PDE", "Partial Differential Equation"),
("BC", "Boundary Condition"),
("DOF", "Degree of Freedom", "Degrees of Freedom"),
)
#abbr.config(space-char: sym.space.nobreak)

#context {
let lang = text.lang
let abbr-title = ""
if lang == "de" {
abbr-title = "Abkürzungsverzeichnis"
} else {
abbr-title = "List of Abbreviations"
}
abbr.list(
title: text(abbr-title, size: 15pt)
)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Schreibe deine Zusammenfassung hier. #lorem(80)
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Write your abstract here. #lorem(80)
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Write your acknowledgement here or leave it out if you do not want one.
#lorem(50)
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
If you need one, write your appendix here.
#lorem(100)

== Appendix sections
In the appendix, use sections instead of chapters since the appendix is a chapter itself.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Die vorliegende Arbeit beinhaltet interne vertrauliche Informationen der Firma XY. Die Weitergabe oder Veröffentlichung des Inhaltes der Arbeit ob gesamt oder in Teilen ist untersagt. Es dürfen keinerlei Kopien oder Abschriften - auch in digitaler Form - gefertigt werden. Ausnahmen bedürfen der schriftlichen Genehmigung der Firma XY.
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
#import "@preview/abbr:0.2.3"

#set heading(numbering: "1.1")

= Example Section <sec:tutorial>
This section contains some example content to show you how to use Typst to write your thesis.

Also, Typst is well-documented. Visit the documentation online: #link("https://typst.app/docs/reference/model/link/")

== Bold and Italic font
In Typst, you can write text in *bold* or _italic_ font by using simple Markdown symbols.

== Line breaks and page breaks
By leaving a line blank in your `.typ`-file, you can create a new *paragraph*. This should be the default way of structuring your text. In LaTeX, this would be `\par`.

You can also create a simple line break by adding a backslash `\` at the end of a line.\
However, since line breaks should be consistent throughout the document, breaking using `\` is usually not recommended.

To insert a pagebreak use `#pagebreak()`.

== Figures <sec:figures>
Figures are referenced like this: @fig:findus shows a funny cat.

#figure(
image("../images/top-right.png", width: 30%),
caption: "This is the figure caption."
) <fig:findus>

Unlike LaTeX, Typst does not have floating figures. Instead, figures are placed where they are defined.

Also, Typst currently cannot embed PDF-files. However, you can still use SVG.

== Citations and references
Citations are referenced like this: `@alley1996craft` is a great book about writing scientific reports (proper citations sadly do not work in this tutorial).\
Note that the bibliography tag stems from the `thesis.bib` file.\
Also, sections can be referenced like this: @sec:figures and @sec:tutorial

== Equations
Equations are written like this:
$sum_i^infinity (f^(\(n\))(a))/(n!) (x-a)^n$.\
Note that adding a space around the equation places it in the center of the page:
$ sum_i^infinity (f^(\(n\))(a))/(n!) (x-a)^n $

Equations can be aligned using `&` for alignment and `\` for line breaks:
$ sum_i^infinity (f^(\(n\))(a))/(n!) (x-a)^n &= f(a)
+ (f'(a))/(1!) (x-a)
+ (f''(a))/(2!) (x-a)^2
+ ...\
&= ...
$

== Math Symbols
In Typst, math symbols are written differently than in LaTeX. For instance, many symbols are written using their names rather than special characters. Here are some examples:

- Greek letters: $alpha$, $beta$, $gamma$, $delta$, $epsilon$
- Operators: $sum$, $product$
- Relations: $<$, $>$, $!=$, $approx$
- Functions: $sin$, $cos$, $tan$, $log$, $exp$

== Abbreviations
Typst supports abbreviations like this: #abbr.pla[PDE] are important in mathematics. To use the singular, use `abbr.a` (auto) and for plural `abbr.pla`.\
Note that a list of all abbreviations shall be written in `texts/abbreviations.typ`.

== Enumerations and bullet points
Enumerations are written like this:
+ First item
+ First subitem
+ Second subitem
+ Second item
+ Third item

You can also have numbers in subitems:
#set enum(full: true)
+ First item
+ First subitem
+ Second subitem
+ Second item

Bullet points are written like this:
- First item
- Second item
- Third item

== Tables
Tables in Typst are written like this:
#figure(
table(
columns: 2,
[*Header 1*], [*Header 2*],
[Row 1, Cell 1], [Row 1, Cell 2],
[Row 2, Cell 1], [Row 2, Cell 2],
[Row 3, Cell 1], [Row 3, Cell 2],
),
caption: "This is the table caption."
) <tab:example-table>

You can reference @tab:example-table as usual.

== Symbols
There is a wide catalog of symbols available in Typst. For example, #sym.arrow.r gives an arrow.
Use the smart suggestions of your editor to find more symbols like #sym.alpha.

== Code
Source code can be typeset like this:
```python
def main():
print("Hello Typst!")
```
However, this is not well-suited for large pieces of code.
Loading