Keyboard

↓ ↑
move between the rows you can see
→
open a feature, then step into it
←
close a feature, or step out to the one above
Enter
go to the page in focus
Tab
the same rows, plus everything else on the page
/
search the whole report
m
open or close the navigation drawer
Esc
leave the search box, or close the drawer
?
this list

Fills a value asked for by token, under whatever key you name

All 6 scenarios hold

A site generator reads an AsciiDoc or Markdown page. The generator decides how that page looks and where it sits in the site. Front matter is what a project tells the generator. Declare it once, in the frontMatter section of the tabletest-reporter.yaml sidecar. The reporter then writes it above every page of a text report. An HTML page carries none, because it is a finished page and not source for a generator.

Both rules below read a report of two test classes in one package, com.example.orders.OrderTest and com.example.orders.ProductTest, with one table each.

The reporter knows three values a site generator cannot work out. Ask for one by its token: $title, $position or $timestamp. Write the token as the value, never as the key. Generators do not agree on what to call a position. Hugo calls it weight, Docusaurus sidebar_position, a Jekyll theme nav_order, and Antora page-weight. Antora exposes a custom attribute under no other prefix.

A page's position is the place the spec metadata declares. A generator that orders pages by that value lists them in the reading order the project chose, and not alphabetically.

The rows below are Markdown. Every text format writes the same values. $timestamp carries the instant the report states it was generated at. A build that pins no instant reads the clock, which is what a blank cell below means.

expected outcome broken scenario
ScenarioDeclaredPage URLRun pinned atPage opens with?
First page of the reading order
  • title: $title
  • weight: $position
/order-test
  • ---
  • title: order-test
  • weight: 1
  • ---
  • # order-test
Second page of the reading order
  • title: $title
  • weight: $position
/product-test
  • ---
  • title: product-test
  • weight: 2
  • ---
  • # product-test
A key named for another generator
  • sidebar_position: $position
/order-test
  • ---
  • sidebar_position: 1
  • ---
  • # order-test
The instant of the run
  • date: $timestamp
/order-test2026-08-23T09:19:33Z
  • ---
  • date: 2026-08-23T09:19:33Z
  • ---
  • # order-test
A page with no position of its own
  • weight: $position
  • layout: report
/
  • ---
  • layout: report
  • ---
  • # orders
A key named for a value, without it
  • title: a title of my own
/order-test
  • ---
  • title: a title of my own
  • ---
  • # order-test