Skip to content

Commit

Permalink
docs: Update book
Browse files Browse the repository at this point in the history
  • Loading branch information
tingerrr committed Feb 18, 2025
1 parent ec7a8d5 commit d545598
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/book/src/reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ The project config is specified in the `typst.toml` manifest under the `tool.tyt
|Key|Default|Description|
|---|---|---|
|`tests`|`"tests"`|The path in which unit tests are found, relative to the project root.|
|`default.dir`|`ltr`|Sets the default direction used for creating difference documents, expects either `ltr` or `rtl` as an argument. Can be overriden per test using an annotation.|
|`default.ppi`|`144.0`|Sets the default pixel per inch used for exporing and comparing documents, expects a floating point value as an argument. Can be overriden per test using an annotation.|
|`default.max-delta`|`1`|Sets the default maximum allowed per-pixel delta, expects an integer between 0 and 255 as an argument. Can be overriden per test using an annotation.|
|`default.max-deviations`|`0`|Sets the default maximum allowed deviations, expects an integer as an argument. Can be overriden per test using an annotation.|

## System Config
There are currently no system config options and the config is not yet loaded.
2 changes: 1 addition & 1 deletion docs/book/src/reference/tests/annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ The following annotations are available:
|`dir`|Sets the direction used for creating difference documents, expects either `ltr` or `rtl` as an argument.|
|`ppi`|Sets the pixel per inch used for exporing and comparing documents, expects a floating point value as an argument.|
|`max-delta`|Sets the maximum allowed per-pixel delta, expects an integer between 0 and 255 as an argument.|
|`max-deviations`|Sets the maximum allwoed deviations, expects an integer as an argument.|
|`max-deviations`|Sets the maximum allowed deviations, expects an integer as an argument.|

0 comments on commit d545598

Please sign in to comment.