Reports

A report is laid out as printed pages, ready to save as a PDF or print. You write it in chapters: each chapter is its own file in the report's outline, and the cover is a file of its own too. The paper size, title, colours, logo and page header are set in Report settings, not in the text. Everything in the basics works in a report too.

Chapters

A # heading starts a new chapter on a new page. The chapter's name goes in the contents page, with its page number.

# Our year

The club grew from 20 members to 34, and we ran our first summer camp.

## Highlights

- A new set of kits, thanks to our sponsors
- Two teams in the county league

What you get: a chapter starting on a fresh page, with "Our year" listed in the contents. The ## heading is a heading inside the chapter.

A page before the contents

Add {.uncounted} to a chapter's heading for a welcome page or a foreword: it has no page number, is not in the contents, and comes before the contents page.

# Welcome {.uncounted}

A word from our chair before you read on.

What you get: a page with no number, placed straight after the cover.

Start a new page

Add {.new-page} to a heading inside a chapter to start it on a new page.

## The accounts {.new-page}

Here is where the money came from and where it went.

What you get: "The accounts" at the top of the next page, with the rest of the chapter following it.

Kicker and lead

A short paragraph with {.kicker} above a chapter heading prints as a small line in capitals. A paragraph with {.lead} is a larger opening paragraph.

Annual report {.kicker}

# A year of firsts

Our first summer camp, our first league title, and our first minibus. {.lead}

The rest of the chapter carries on in ordinary text.

What you get: "ANNUAL REPORT" in small capitals just above the heading, then the opening paragraph set larger than the text that follows.

Callouts, banners and cards

These blocks make a piece of text stand out: callout is a boxed note, banner a strip across the page, and card a rounded panel.

::: callout
Membership fees stay at £5 a month for the coming year.
:::

::: banner
Summer camp is back: 4 to 8 August
:::

::: card
**Volunteer of the year:** Sam, who ran the tuck shop every Saturday.
:::

What you get: a boxed note, a coloured banner and a card, each styled by the report's theme. ::: card dark gives a dark card.

Columns

Put text in a columns block and it flows down one column and on into the next, as in a newsletter. Add three for three columns, and ruled for a line between them.

::: columns three ruled
The under-12s won six of their eight matches this season, and finished
second in the league.

The under-14s had a harder year, but two players were picked for the county
squad.

The adults' team trained every Wednesday night and played twelve friendlies.
:::

What you get: the text in three columns with a line between each, carrying on to the next page if it runs over.

Numbered promises

Put a numbered list in a pledges block for big numbered boxes. A bold phrase at the start of each item is its heading.

::: pledges
1. **More teams.** An under-10s team by the spring.
2. **Better pitches.** New drainage on the lower field.
3. **Lower costs.** Kit and fees kept at this year's prices.
:::

What you get: three large numbered boxes, each with its bold heading and its line of text.

Footnotes

Put [^1] where a note belongs, and the note itself on a line of its own starting [^1]:. Number the notes from 1 in each chapter.

Attendance rose by a third over the year.[^1]

[^1]: From the weekly registers, September to July.

What you get: a small number after "year", and the note printed at the foot of the same page. Numbers run on through the whole report.

Pictures to the edge

Add {.bleed} to a picture to run it out to the edges of the paper.

![The team at the summer camp](images/camp.jpg){.bleed}

What you get: the photo across the full width of the page, with no white margin either side.

Tables of figures

Put a table in a figures block for a clean table of numbers. A row whose first cell is bold is a total, with a double line above it.

::: figures units="£"
| Where the money came from | 2025  | 2026  |
|---------------------------|------:|------:|
| Membership fees           | 1,800 | 2,040 |
| Sponsors                  | 600   | 750   |
| Bake sales                | 220   | 310   |
| **Total**                 | **2,620** | **3,100** |
:::

What you get: a table with no grid lines, the numbers lined up on the right, "£" over the figures, and the total row set apart.

Charts

Put a table in a chart block and it is drawn as a chart. The first column is along the bottom, and each other column is a set of bars (or a line).

::: chart line {title="Members each season" y-label="Members"}
| Season | Juniors | Adults |
|--------|--------:|-------:|
| 2023   | 12      | 8      |
| 2024   | 16      | 9      |
| 2025   | 21      | 13     |
:::

What you get: a line chart with a line for juniors and one for adults, and a key. Use bar, area, stacked, pie or donut in place of line for other kinds of chart.

QR codes

A qr block with a web address prints a QR code that a phone can scan.

::: qr https://example.com/join
:::

Scan to join the club.

What you get: a QR code that opens the web address, with the line of text under it.

More

  • The basics: lists, pictures, tables, blocks and shapes, all of which work in a report.
  • Try it in the editor: start a new report and paste an example into a chapter.