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

Uses your template when its file name matches the page

All 5 scenarios hold

Pebble templates render a report, and a project can supply its own. Point the reporter at a template directory. The reporter then uses the files in that directory in place of the built-in templates, or on top of them.

The rules below read a report of one test class named Calendar. That class holds one table named Leap years, with the columns Year and Leap? and one row, 2004 and Yes. A report that small lets a rule state a whole page.

One template renders one page in one format. The reporter has seven slots for them: a table and an index page in markdown, in asciidoc and in html, and the single-file html page. The rows below use the markdown slots.

Reach for the hyphen form when your template extends the built-in one, because a template cannot extend itself.

expected outcome broken scenario
ScenarioYour template directoryTable page?Index page?
No template of your own[:]
  • ## Leap years
  • “”
  • | Year | Leap? |
  • | --- | --- |
  • | 2004 | Yes |
  • # Calendar
  • “”
  • * [Leap years](./leap-years.md)
The name of the table page
table.md.peb
  • # {{ title }} of note
  • Written by hand.
  • # Leap years of note
  • Written by hand.
  • # Calendar
  • “”
  • * [Leap years](./leap-years.md)
A hyphen before that name
my-table.md.peb
  • # {{ title }} of note
  • Written by hand.
  • # Leap years of note
  • Written by hand.
  • # Calendar
  • “”
  • * [Leap years](./leap-years.md)
That name without the hyphen
mytable.md.peb
  • # {{ title }} of note
  • Written by hand.
  • ## Leap years
  • “”
  • | Year | Leap? |
  • | --- | --- |
  • | 2004 | Yes |
  • # Calendar
  • “”
  • * [Leap years](./leap-years.md)
The name of the index page
index.md.peb
  • # {{ title }} of note
  • Written by hand.
  • ## Leap years
  • “”
  • | Year | Leap? |
  • | --- | --- |
  • | 2004 | Yes |
  • # Calendar of note
  • Written by hand.