Lateen

Table

2 minutes read

A table shows data in rows and columns. The theme wraps every Markdown table in a scroll region, so a wide table scrolls inside the article instead of widening the page. A table that fits gains no extra tab stop and no landmark when the theme's island runs; a wide table stays focusable and, when it has a caption, is named.

Syntax

A GFM pipe table:

| Environment | Target |
| --- | --- |
| staging | `s3://staging` |
| production | `s3://production` |

There is no directive.

Options

None for Markdown. GFM has no caption syntax, so a Markdown table has no region name and is not announced as a landmark; it still gets the focusable scroll region when it overflows. That keeps a page from collecting repeated generic "Table" landmarks.

When a table does have a caption, as produced by a pipeline or a component, the caption names the region. A component that renders a table directly can pass label instead. A table with neither stays keyboard-scrollable but unnamed.

Example

Environment Target Hooks
staging s3://beacon-staging none
production s3://beacon-prod after

Notes

  • Keep the table narrow enough to scan. For two columns of prose, a definition list or two paragraphs may read better.
  • The alignment row is required; --- on its own is enough.
  • Inline code in cells is the clearest way to name a field, a path, or a value.
  • A table is never a layout tool; use steps or a list for a sequence.
  • Without JavaScript the wrapper stays focusable, so a wide table can still be scrolled with the arrow keys. With JavaScript it drops that tab stop whenever the table fits, and adds it back when the viewport, zoom, or text size makes the table overflow.
View Markdown

Use with an agent
View Markdown

Open in

On this page