Skip to content

Commit

Permalink
Readme fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
knuesel committed Jun 29, 2024
1 parent f5fe6eb commit 6113106
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ The package also works well with [pinit](https://typst.app/universe/package/pini
#pinit-highlight(5,6, fill: green.transparentize(80%))
#pinit-point-from(6)[larger than $a^2$ and $b^2$]
]
```


### Handout mode
Expand Down Expand Up @@ -145,7 +146,7 @@ The behavior of the minideck functions depends on the settings passed to `minide

`minideck.config` accepts the following named arguments:

* `paper`: a string for one of the paper size names recognized by [`page.paper`](https://typst.app/docs/reference/layout/page/#parameters-paper), or one of the shorthands "16:9" or "4:3". Default: "4:3".
* `paper`: a string for one of the paper size names recognized by [`page.paper`](https://typst.app/docs/reference/layout/page/#parameters-paper), or one of the shorthands `"16:9"` or `"4:3"`. Default: `"4:3"`.
* `landscape`: use the paper size in landscape orientation. Default: `true`.
* `width`: page width as an absolute length. Takes precedence over `paper` and `landscape`.
* `height`: page height as an absolute length. Takes precedence over `paper` and `landscape`.
Expand All @@ -158,7 +159,7 @@ For example to make slides with 16:9 aspect ratio, use `minideck.config(paper: "

### Themes

Use `minideck.config(theme: ...)` to select a theme. Currently there is only one built-in: `minideck.themes.simple`. However you can also pass a theme implemented by yourself or from a third-party package. See the [theme documentation](themes/Readme.md) for how that works.
Use `minideck.config(theme: ...)` to select a theme. Currently there is only one built-in: `minideck.themes.simple`. However you can also pass a theme implemented by yourself or from a third-party package. See the [theme documentation](themes/README.md) for how that works.

Themes are functions and can be configured using the standard [`with` method](https://typst.app/docs/reference/foundations/function/#definitions-with):

Expand Down
4 changes: 2 additions & 2 deletions themes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The theme functions that make slides (`slide`, `title-slide` and possibly others

For example an `ocean` theme from a `fancy-themes` package could be used like this:

```
```typst
import "minideck"
import "fancy-themes"
#let (template, slide, title-slide) = minideck.config(theme: fancy-themes.ocean)
Expand All @@ -30,7 +30,7 @@ import "fancy-themes"

or when theme configuration is required:

```
```typst
import "minideck"
import "fancy-themes"
#let (template, slide, title-slide) = minideck.config(
Expand Down

0 comments on commit 6113106

Please sign in to comment.