docs: refresh README and examples
This commit is contained in:
3 files changed
+10
-5
No files matched your search
@@ -24,6 +24,9 @@ A simple exercise sheet using the `base-template` layout.
|
|||||||
A formal exercise sheet using the `formal-template` layout.
|
A formal exercise sheet using the `formal-template` layout.
|
||||||
[View source code](examples/formal.typ)
|
[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
|
## Quick start
|
||||||
|
|
||||||
@@ -36,7 +39,7 @@ typst init @preview/clean-sheets:0.3.0
|
|||||||
Or import the package in an existing document:
|
Or import the package in an existing document:
|
||||||
|
|
||||||
```typst
|
```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(
|
#show: body => base-template(
|
||||||
1,
|
1,
|
||||||
@@ -47,12 +50,13 @@ Or import the package in an existing document:
|
|||||||
([Jane Doe], [John Doe]),
|
([Jane Doe], [John Doe]),
|
||||||
[Taylor Tutor],
|
[Taylor Tutor],
|
||||||
show-logo: false,
|
show-logo: false,
|
||||||
|
show-credits: true,
|
||||||
body,
|
body,
|
||||||
)
|
)
|
||||||
|
|
||||||
= Exercise 1
|
= Exercise 1
|
||||||
|
|
||||||
#ex_box(heading: [Warm-up], points: [10 points])[
|
#exercise(heading: [Warm-up], points: [10 points])[
|
||||||
Prove that $1 + 1 = 2$.
|
Prove that $1 + 1 = 2$.
|
||||||
]
|
]
|
||||||
|
|
||||||
@@ -151,6 +155,7 @@ to either template.
|
|||||||
|
|
||||||
## License and credits
|
## License and credits
|
||||||
|
|
||||||
Clean Sheets is licensed under the MIT License. The bundled
|
Clean Sheets is licensed under the [MIT License](LICENSE). The bundled
|
||||||
`assets/OneHalfLight.tmTheme` is the MIT-licensed One Half Light theme by Son
|
`assets/OneHalfLight.tmTheme` is the MIT-licensed
|
||||||
Pham; see `LICENSE-OneHalfLight`.
|
[One Half Light theme](https://github.com/sonph/OneHalf) by Son Pham; see
|
||||||
|
[`LICENSE-OneHalfLight`](LICENSE-OneHalfLight).
|
||||||
Binary file not shown.
Binary file not shown.
Reference in new issue
Block a user