Skip to content

Commit 53dcefc

Browse files
authored
Feat: Remove newlines, fix grammar and add more examples (#1)
* propose more concise abstract * add second author example * fix: remove line-breaks * fix: grammar * use syntax highlighting for functions * fix: typo in README
1 parent 9ec7902 commit 53dcefc

File tree

2 files changed

+50
-125
lines changed

2 files changed

+50
-125
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This repository provides a simple Typst template for writing your Assignments at UiT (The Arctic University of Tromsø). The template is _supercharged_ with the [typst](https://typst.app/home) language, which is a simple and powerful language for writing scientific documents.
44

5-
> [!NOTE]
5+
> [!NOTE]
66
> This is only a template. You have to adapt the template to your current assignment!
77
88
## Installation
@@ -17,7 +17,7 @@ To use this template, you need to have the `typst` language installed on your co
1717

1818
For more information on how to install `typst`, please refer to the [official documentation](https://github.com/typst/typst?tab=readme-ov-file#installation).
1919

20-
## Usage
20+
## Usage
2121

2222
### Set up the assignments metadata
2323

@@ -28,7 +28,7 @@ Fill in your assignment details in the `uit_template` function, it should contai
2828
- Your Index Terms
2929
- An Abstract
3030

31-
### Build PDFs locally
31+
### Build PDFs locally
3232

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

@@ -48,20 +48,19 @@ faster than compiling from scratch each time because Typst has incremental compi
4848
typst watch main.typ
4949
```
5050

51-
### Working in the Typst Web Editort
51+
### Working in the Typst Web Editor
5252

53-
If you prefer an Overleaf-like experience with autocompletion, preview and (soon)spellchecking, then the Typst web editor is for you. It allows you to import files directly into a new or existing document. Here's a step-by-step guide:
53+
If you prefer an Overleaf-like experience with autocompletion, preview and (soon)spellchecking, then the Typst web editor is for you. It allows you to import files directly into a new or existing document. Here's a step-by-step guide:
5454

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

5757
2. Create or Sign in to your Account.
5858

59-
2. Create a new blank document.
59+
3. Create a new blank document.
6060

61-
3. Click on "File" on the top left menu, then "Upload File".
61+
4. Click on "File" on the top left menu, then "Upload File".
6262

63-
4. Select all `.typ` and `.bib` files along with the figures (svg and png) provided in this template repository.
63+
5. Select all `.typ` and `.bib` files along with the figures (svg and png) provided in this template repository.
6464

65-
> [!NOTE]
65+
> [!NOTE]
6666
> You can select multiple files to import at the same time. The editor will import and arrange all the files accordingly. Watch out if your figures are in a directory, the may end up in root.
67-

0 commit comments

Comments
 (0)