https://github.com/sebaseb98/clean-math-thesis
Typst thesis template specialized on needs of mathematics.
https://github.com/sebaseb98/clean-math-thesis
template thesis thesis-template typst typst-template
Last synced: 3 months ago
JSON representation
Typst thesis template specialized on needs of mathematics.
- Host: GitHub
- URL: https://github.com/sebaseb98/clean-math-thesis
- Owner: sebaseb98
- License: mit
- Created: 2024-10-23T11:39:31.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-03-05T21:55:22.000Z (4 months ago)
- Last Synced: 2025-03-05T22:34:01.051Z (4 months ago)
- Topics: template, thesis, thesis-template, typst, typst-template
- Language: Typst
- Homepage: https://typst.app/universe/package/clean-math-thesis
- Size: 1.17 MB
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# clean-math-thesis
[](https://github.com/sebaseb98/clean-math-thesis/actions/workflows/build.yml)
[](https://github.com/sebaseb98/clean-math-thesis)
[](https://opensource.org/licenses/MIT)
[Typst](https://typst.app/home/) thesis template for mathematical theses built for simple, efficient use and a clean look.
Of course, it can also be used for other subjects, but the following math-specific features are already contained in the template:
- theorems, lemmas, corollaries, proofs etc. prepared using [great-theorems](https://typst.app/universe/package/great-theorems)
- equation settings (using either [equate](https://typst.app/universe/package/equate) for numbering of subequations or [i-figured](https://typst.app/universe/package/i-figured/) for equation numbering which includes the chapter number)
- pseudocode package [lovelace](https://typst.app/universe/package/lovelace) included.
Additionally, it has headers built with [hydra](https://typst.app/universe/package/hydra).
## Set-Up
The template is already filled with dummy data, to give users an [impression how it looks like](https://github.com/sebaseb98/clean-math-thesis/blob/main/template/main.pdf). The thesis is obtained by compiling `main.typ`.
- after [installing Typst](https://github.com/typst/typst?tab=readme-ov-file#installation) you can conveniently use the following to create a new folder containing this project.
```bash
typst init @preview/clean-math-thesis:0.3.0
```
- edit the data in `main.typ` → `#show template.with([your data])`
### Parameters of the Template
personal/subject related information
- `author`: Name of the author of the thesis.
- `title`: Title of the thesis.
- `supervisor1`: Name of the first supervisor.
- `supervisor2`: Name of the second supervisor.
- `degree`: Degree for which the thesis is submitted.
- `program`: Program under which the thesis is submitted.
- `university`: Name of the university.
- `institute`: Name of the institute.
- `deadline`: Submission deadline of the thesis.
file paths for logos etc.
- `uni-logo`: Image, e.g. `image("images/logo_placeholder.svg", width: 50%)`
- `institute-logo`: Image.
formatting settings
- `citation-style`: Citation style to be used in the thesis.
- `body-font`: Font to be used for the body text.
- `cover-font`: Font to be used for the cover text.
content that needs to be placed differently then normal chapters
- `abstract`: Content for the abstract section.
equation settings
- `equate-settings`: either none -> use i-figured; or tuple with the settings for the equations (see [docs](https://typst.app/universe/package/equate)), e.g. (breakable: true, sub-numbering: true, number-mode: "label")
The switching between these is currently not optimal: i-figured needs a prefix (`eq:`) so if we label an equation like `` the corresponding reference is `@eq:equation` and for equate we don't have this prefix, i.e. the reference would be `@equation` in this example. This is something to be improved in future releases.
- `equation-numbering-pattern`: specify the [numbering](https://typst.app/docs/reference/model/numbering/#parameters-numbering) of the equations. The second counting symbol (e.g. the `a` in `"(1.a)"`) is either used for subequation numbering or for the numbering of equations in the chapters.
colors
- `cover-color`: Color used for the cover.
- `heading-color`: Color used for headings.
- `link-color`: Color used for links and references.
### Other Customizations
- `declaration.typ` should be modified
- when adding chapters, remember to include them into the `main.typ`.
- (optional) change colors and appearance of the theorem environment in the `customization/`-folder.
### Use of the template in existing projects
If you want to change an existing typst project structure to use this template, just type the following lines
```typ
#import "@preview/clean-math-thesis:0.3.0": template
#show: template.with(
// your user specific data, parameters explained above
)
#include "my_content.typ" // and eventually more files
```
## Disclaimer
This template was created after Sebastian finished his master's thesis.
We do not guarantee that it will be accepted by any university, please clarify in advance if it fulfills all requirements. If not, this template might still be a good starting point.
## Acknowledgements
As inspiration on how to structure this template, we used the [modern-unito-thesis](https://typst.app/universe/package/modern-unito-thesis) template. The design is inspired by the [fau-book](https://github.com/FAU-AMMN/fau-book) template.
## Feedback & Improvements
If you encounter problems, please open issues. In case you found useful extensions or improved anything We are also very happy to accept pull requests.