typst-kfu-slides-template/README.md
Ernesto Martínez García 3cea9482e7
Update README.md
2025-08-23 18:01:47 +02:00

112 lines
3.7 KiB
Markdown

# Typst ISEC Slides Template
> An opinionated version of the ISEC slides template made in Typst. Easily configurable for other institutes or organizations.
Quickstart (CLI):
> [!NOTE]
> This is temporary and the template will be upstreamed in Typst Universe so
> that not a single clone is needed
```sh
git clone git@github.com:ecomaikgolf/typst-isec-slides-template.git ~/.local/share/typst/packages/local/definitely-not-isec-slides/
typst init @local/definitely-not-isec-slides:1.0.0 slides
```
Quickstart (WebIDE):
> [!WARNING]
> This won't work until the package is upstreamed & published, use the CLI
> method
- [Create Document](https://typst.app/app?template=definitely-not-isec-slides&version=1.0.0)
- [Homepage](https://typst.app/universe/package/definitely-not-isec-slides)
> [!NOTE]
> If you are an ISEC or TUGraz employee and think that `isec-thesis` or
> `tugraz-thesis` fits more, I would need an approval to allocate the name :)
Tested typst version: `0.13.1`.
## Typst
### What's Typst?
A modern typesetting system which has:
- Milisecond incremental (memoized) builds¹
- Subsecond full builds¹
- Multithreaded builds per pagebreak
- Easy rustc-like compiler error messages (and no intermediates!)
- Transparent multiple compiler passes (no more mklatex/makefiles)
- Simple & powerful scripting and syntax
- WebAssembly plugin support (python/js interpreters in your thesis? Sure)
Migrating from LaTeX? Check the [migration guide](https://typst.app/docs/guides/guide-for-latex-users/)
¹: This is obviously not a serious benchmark and depends on the document. But
it's fast trust me
### Quick usage
Start incremental compilations with:
```sh
typst watch slides.typ
```
then open the generated PDF:
```sh
xdg-open slides.typ
```
Now edit `slides.typ` and it will be incrementally built in each save.
## Design
---
<img width="1754" height="987" alt="title" src="https://github.com/user-attachments/assets/d29f53ff-0622-45fe-9727-7d286e8d15b1" />
---
<img width="1754" height="987" alt="list" src="https://github.com/user-attachments/assets/27dc198d-714d-4ed6-ad2e-f39babcf4fce" />
---
<img width="1754" height="987" alt="listimage" src="https://github.com/user-attachments/assets/b16cb69b-c9a1-4f50-8fd5-e7c3b0a97617" />
---
<img width="1754" height="987" alt="standout" src="https://github.com/user-attachments/assets/179960f4-e909-4856-8aba-6beb7a91e3c5" />
---
<img width="1754" height="987" alt="colors" src="https://github.com/user-attachments/assets/312a013e-fd89-4b6a-921b-bbfe9f4fa565" />
---
<img width="1754" height="987" alt="features" src="https://github.com/user-attachments/assets/1f3cd158-3860-4962-9802-7fc22d4b94a1" />
---
<img width="1754" height="987" alt="code" src="https://github.com/user-attachments/assets/508abb37-8224-4ef8-9424-2f367981b91f" />
---
<img width="1754" height="987" alt="blocks" src="https://github.com/user-attachments/assets/e4214dc0-f434-40d2-b1fa-0463ef18d9b7" />
---
<img width="1754" height="987" alt="plots" src="https://github.com/user-attachments/assets/605a3bab-c040-4932-9777-03dffabb3a9f" />
---
<img width="1754" height="987" alt="configurable" src="https://github.com/user-attachments/assets/310a25e2-981c-40b3-bbcb-fc243cbb5983" />
---
<img width="1754" height="987" alt="blank" src="https://github.com/user-attachments/assets/7533e702-bba3-4462-add2-f2fbe1e50a20" />
---
<img width="1754" height="987" alt="bibliography" src="https://github.com/user-attachments/assets/03d9f47a-e082-4e89-92f2-b3c746dd8f34" />
## License `src/assets/tuglogo.svg`
According to Wikipedia:
> This logo image consists only of simple geometric shapes or text. It does not
> meet the threshold of originality needed for copyright protection, and is
> therefore in the public domain. [...]
https://en.m.wikipedia.org/wiki/File:TU_Graz.svg