Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ls1intum/thesis-template-typst

TUM ASE thesis typst template
https://github.com/ls1intum/thesis-template-typst

Last synced: 26 days ago
JSON representation

TUM ASE thesis typst template

Lists

README 

        
# thesis-template-typst

This repository provides a comprehensive Typst template for writing your Bachelor's or Master's thesis at the CIT School of TUM (Technical University of Munich). It includes two types of documents: a proposal template and a thesis template, both specifically designed for students in the field of Informatics. For more information about writing a thesis at the CIT School, please visit the [official CIT website](https://www.cit.tum.de/en/cit/studies/students/thesis-completing-your-studies/informatics/).



**Note:** This is only a template. You have to adapt the template to your thesis and discuss the structure of your thesis with your supervisor!



--- 

## Guidelines 



__Please thorougly read our guidelines and hints on [confluence](https://confluence.ase.in.tum.de/display/EduResStud/How+to+thesis)!__ (TUM Login Required) 



---

## Installation



For detailed installation instructions, please refer to the [official installation guide](https://github.com/typst/typst). Here, we provide basic steps for installing Typst's CLI:



- You can get sources and pre-built binaries from the [releases page](https://github.com/typst/typst/releases).

- Use package managers like `brew` or `pacman` to install Typst. Be aware that the versions in the package managers might lag behind the latest release.

- If you have a [Rust](https://rustup.rs/) toolchain installed, you can also install the latest development version.



Nix and Docker users, please refer to the official installation guide for detailed instructions.



## Usage

### Set thesis metadata 

Fill in your thesis details in the [`metadata.typ`](/metadata.typ) file: 

* Degree (Bachelor or Master)

* Your study program

* English and German title

* Advisor and supervisor

* Your name (without e-mail address or matriculation number)

* The start and submission date



### Write your thesis

For the actual content of your thesis, there is a dedicated folder named [`/content`](/content) which includes all the chapters and sections of your thesis. This applies for the proposal as well as the thesis (see [`/content/proposal.typ`](/content/proposal.typ) for proposal content). 

You can add or remove chapters as needed (adapt the [`thesis.typ`](/thesis.typ) with the `#include(...)` accordingly).

If you need to customize the layout of the template, you can do so by modifying the corresponding file in the [`layout`](/layout) directory.



### Build PDFs locally 

Once you have installed Typst, you can use it like this:

```sh

# Creates `thesis.pdf` in working directory.

typst compile thesis.typ



# Creates `proposal.pdf` in working directory.

typst compile proposal.typ



# Creates PDF file at the desired path.

typst compile thesis.typ path/to/output.pdf

```



You can also watch source files and automatically recompile on changes. This is

faster than compiling from scratch each time because Typst has incremental

compilation.

```sh

# Watches source files and recompiles on changes.

typst watch thesis.typ

```



## Working with the Typst Web Editor



If you prefer an integrated IDE-like experience with autocompletion and instant preview, the Typst web editor allows you to import files directly into a new or existing document. Here's how you can do this:



1. Navigate to the [Typst Web Editor](https://typst.app/).

2. Create a new blank document.

3. Click on "File" on the top left menu, then "Upload File".

4. Select all .typ and .bib files along with the figures provided in this template repository.



**Note:** You can select multiple files to import. The editor will import and arrange all the files accordingly. Always ensure you have all the necessary .typ, .bib, and figures files you need for your document.



---

## Further Resources



- [Typst Documentation](https://typst.app/docs/)

- [Typst Guide for LaTeX Users](https://typst.app/docs/guides/guide-for-latex-users/)

- [Typst VS Code Extension (inofficial)](https://marketplace.visualstudio.com/items?itemName=nvarner.typst-lsp)