Introduction

Tytanic is a test runner for Typst projects. It helps you worry less about regressions and speeds up your development.

Bird's-Eye View

Out of the box Tytanic supports the following features:

• compile and compare tests
• manage tests of various types
• manage and update reference documents when tests change
• filter tests effectively for concise test runs

A Closer Look

This book contains a few sections aimed at answering the most common questions right out the gate:

• Installation outlines various ways to install Tytanic.
• Usage goes over some basic commands to get started.

After the quick start, a few guides delve deeper into some advanced topics, such as

• Writing Tests shows how tests work and how you can add, remove and update them.
• Using Test Sets delves into the test set language and how it can be used to isolate tests and speed up your TDD workflow.
• Watching for Changes explains a workaround for how you can run tests repeatedly on changes to your project files.
• Setting Up CI shows how to set up Tytanic in your CI.

The later sections of the book are a technical reference to Tytanic and its various features or concepts:

• Typst Compatibility shows which versions of typst are currently supported and in which version of Tytanic.
• Tests explains all features of tests in-depth.
• Test Set Language explains the ins and outs of the test set language, listing its operators, built-in bindings and syntactic and semantic intricacies.
• Configuration Schema lists all existing config options, their expected types and default values.