docs: refresh README and examples

This commit is contained in:
Popa committed 2026-09-11 17:14:18 +02:00
1 parent 55d25f7827
commit 520a133fde
3 files changed
+10 -5

No files matched your search

+10 -5
View File
@@ -24,6 +24,9 @@ A simple exercise sheet using the `base-template` layout.
A formal exercise sheet using the `formal-template` layout.
[View source code](examples/formal.typ)
**Note:** The `formal-template` layout is currently designed for
**_German-language courses only_**. Full customisation may be supported in
future releases.
## Quick start
@@ -36,7 +39,7 @@ typst init @preview/clean-sheets:0.3.0
Or import the package in an existing document:
```typst
#import "@preview/clean-sheets:0.3.0": base-template, ex_box, qed
#import "@preview/clean-sheets:0.3.0": base-template, exercise, qed
#show: body => base-template(
1,
@@ -47,12 +50,13 @@ Or import the package in an existing document:
([Jane Doe], [John Doe]),
[Taylor Tutor],
show-logo: false,
show-credits: true,
body,
)
= Exercise 1
#ex_box(heading: [Warm-up], points: [10 points])[
#exercise(heading: [Warm-up], points: [10 points])[
Prove that $1 + 1 = 2$.
]
@@ -151,6 +155,7 @@ to either template.
## License and credits
Clean Sheets is licensed under the MIT License. The bundled
`assets/OneHalfLight.tmTheme` is the MIT-licensed One Half Light theme by Son
Pham; see `LICENSE-OneHalfLight`.
Clean Sheets is licensed under the [MIT License](LICENSE). The bundled
`assets/OneHalfLight.tmTheme` is the MIT-licensed
[One Half Light theme](https://github.com/sonph/OneHalf) by Son Pham; see
[`LICENSE-OneHalfLight`](LICENSE-OneHalfLight).