-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This adds a basic outline and introduction to the mdbook.
- Loading branch information
Showing
2 changed files
with
68 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Introduction | ||
`typst-test` is a test runner for [Typst](https://typst.app/) projects. It helps you worry less about regressions and speeds up your development. | ||
|
||
## Bird's-Eye View | ||
Out of the box `typst-test` supports the following features: | ||
- locate the project it is invoked in | ||
- collect and manage test scripts and references | ||
- compile and run tests | ||
- compare test output to references | ||
- provide extra scripting functionality | ||
- running custom scripts for test automation | ||
|
||
## A Closer Look | ||
This book contains a few sections aimed at answering the most common questions right out the gate. | ||
- [Installation](./quickstart/install.md) outlines various ways to install `typst-test`. | ||
- [Usage](./quickstart/usage.md) goes over some basic commands to get started with `typst-test`. | ||
- [Features](./quickstart/features.md) introduces various concepts to help you use `typst-test` effectively. | ||
- [Configuration](.quickstart/config.md) explains commonly used configuration keys. | ||
|
||
After the quick start a few guides delve deeper into some advanced topics. | ||
- [Automation](./guides/automation.md) explains the ins and outs of hooks and how they can be used for testing typst preprocessors or formatters. | ||
- [Using Test Sets](./guides/test-sets.md) delves into the test set language and how it can be used to isolate tests and speed up your TDD workflow. | ||
- [Setting Up CI](./guides/ci.md) shows how to set up `typst-test` to continously test all changes to your package. | ||
|
||
The later sections of the book are a technical reference to `typst-test` and its various features or concepts. | ||
- [Tests](./reference/tests.md) outlines which types of tests `typst-test` supports, how they can be customized and which features are offered within the test scripts. | ||
- [Test Set Language](./reference/test-set-dsl.md) defines the test set language and its built in test sets. | ||
- [Configuration Schema](./reference/config.md) lists all existing config options, their expected types and default values. | ||
- [Command Line Tool](./reference/cli.md) goes over the `typst-test`s various sub commands, arguments and options. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,39 @@ | ||
# Summary | ||
[Introduction](./README.md) | ||
|
||
# Quickstart | ||
- [Installation]() | ||
- [Usage]() | ||
- [Concepts]() | ||
- [Configuration]() | ||
|
||
# Guides | ||
- [Automation]() | ||
- [Using Test Sets]() | ||
- [Setting Up CI]() | ||
|
||
# Reference | ||
- [Tests]() | ||
- [Reference Kinds]() | ||
- [Annotations]() | ||
- [Directory Structure]() | ||
- [Test Set Language]() | ||
- [Grammar]() | ||
- [Built-in Test Sets]() | ||
- [Configuration Schema]() | ||
- [Template]() | ||
- [Hooks]() | ||
- [Command Line Tool]() | ||
- [Global Options]() | ||
- [Command Reference]() | ||
- [init]() | ||
- [uninit]() | ||
- [status]() | ||
- [list]() | ||
- [compile]() | ||
- [run]() | ||
- [update]() | ||
- [add]() | ||
- [edit]() | ||
- [remove]() | ||
- [util]() |