README.md (3324B)
1 # KIT Slides Theme for Typst 2 3 A Karlsruhe Institute of Technology theme for typesetting slides in Typst. 4 5 This theme uses [polylux](https://github.com/andreasKroepelin/polylux) for creating slides in Typst. 6 You can find more information on available functions in the [polylux book](polylux.dev/book). 7 8 The simplest way to use this template in the Typst web app is to first add this [read-only shared project](https://typst.app/project/rMlNud7c83Ybf0R2B9BBTt) to your account, then create a copy of it from your dashboard. 9 10 11 ## Usage 12 13 Clone this repository, then use `presentation.typ` as a starting point for your presentation. 14 15 The theme is imported and loaded using 16 ```typst 17 #import "kit-slides.typ": * 18 19 #show: kit-theme.with( 20 title: [The title of your presentation], 21 subtitle: [ 22 The subtitle of your presentation \ 23 Can contain two lines 24 ], 25 author: [Your name], 26 short-title: [A short title to display at the bottom of all slides. Default to your title], 27 group-logo: image("Path to the logo of your group"), // Optional 28 date: [The date of the presentation], 29 language: "de", // The language of the presentation. Supports "de" and "en". 30 institute: [Your institute], 31 ) 32 ``` 33 34 Next insert the title slide using 35 ```typst 36 #title-slide(banner: image("Path to your banner image")) 37 ``` 38 39 Now you can add more slides using 40 ```typst 41 #slide(title: [Your slide title])[ 42 Your slide content 43 ] 44 ``` 45 46 47 ## Compiling 48 49 We recommend using [pixi](https://pixi.sh) as a task and environment manager. You can however also use a regular typst installation. 50 51 ### Using pixi 52 53 ```bash 54 # compile once 55 pixi run compile 56 ``` 57 58 ```bash 59 # watch for changes and recompile automatically 60 pixi run watch 61 ``` 62 63 Pixi also allows you to easily run different linters. 64 This template currently ships with `typos` to find typos and `typstyle` to format your typst code. 65 ```bash 66 # run all linters 67 pixi run lint 68 ``` 69 70 ### Using a local typst installation 71 72 ```bash 73 # compile once 74 typst compile --font-path fonts/ thesis.typ 75 ``` 76 77 ```bash 78 # watch for changes and recompile automatically 79 typst watch --font-path fonts/ thesis.typ 80 ``` 81 82 Make sure to not forget the `--font-path` argument as typst will otherwise silently use different fonts. 83 84 85 ## Fonts 86 87 The KIT design guide requires using Arial (Windows) or Helvetica (MacOS) for office documents, including presentations. Because neither of those fonts is usually available on Linux machines this template ships with the free Roboto font to prevent typst from falling back to a serif font. Roboto is also approved by the KIT design guide, though only for web content, not office documents. 88 If you use this template in an official capacity it is recommended to install a copy of Arial on your system. 89 90 91 ## Stability 92 93 This theme is still very new. I'll try to keep incompatible changes to a minimum, but can't promise that there won't be any incompatible changes. 94 95 96 ## License 97 98 The source code of this theme, excluding files in the `kit/` and `fonts/Roboto/` directories, is licensed under the MIT license. See [LICENSE.txt](./LICENCE.txt) for details. 99 100 The "Karlsruhe Institute of Technology" logo in both German and English language is a protected word and figurative mark of the Karlsruhe Institute of Technology and must only be used in accordence with their usage policy.