Tables
Tables use ordinary GFM pipe syntax. The table render hook wraps each table in a horizontally scrollable region.
The {…} attribute line below selects captions, compatibility matrices, field lists, numbering, or tabs.
Merged cells, sorting, and filtering are unsupported. If you need these features, change the presentation of the data.
Shortest form
Without an attribute line, the result is an ordinary table. The delimiter row controls alignment.
Header cells use th scope="col".
| Component | Port | Purpose |
|---|---|---|
| PostgreSQL | 5432 | Database |
| Pgbouncer | 6432 | Connection pool |
| Patroni | 8008 | High-availability orchestration |
Wide tables scroll themselves
Wide tables scroll within their own region instead of widening the page. Press Tab to focus the region, then use arrow keys to scroll. Its accessible name is the localized “Scrollable table”.
| Cluster | Role | Version | State | Lag | Connections | Size | Backup |
|---|---|---|---|---|---|---|---|
| pg-meta | primary | 18.1 | running | — | 42 | 12 GB | 2026-08-17 |
| pg-test | replica | 18.1 | streaming | 12 ms | 8 | 12 GB | 2026-08-17 |
Captions
{caption="…"} adds a visible <caption>. The caption is plain text and does not number the table.
Its title has balanced padding inside the table frame and aligns with the column labels below it.
| Item | Value |
|---|---|
| Theme version | v0.8.1 |
| Hugo floor | 0.168.0 Extended |
| Licence | Apache-2.0 |
Compatibility matrices
Use {.matrix} for support matrices. The first column becomes a row header with th scope="row".
The header row and first column stay fixed while scrolling. Other cells are centered unless the delimiter row specifies another alignment.
Authors write ✅ and ❌ characters. The theme does not interpret them.
| OS / PG | PG18 | PG17 | PG16 | PG15 | PG14 |
|---|---|---|---|---|---|
| EL 9 | ✅ | ✅ | ✅ | ✅ | ✅ |
| EL 8 | ✅ | ✅ | ✅ | ✅ | ✅ |
| Debian 13 | ✅ | ✅ | ✅ | ❌ | ❌ |
| Ubuntu 24.04 | ✅ | ✅ | ✅ | ✅ | ❌ |
Using the whole canvas
{.full-width} removes the reading-column limit and uses the article’s full width. Use it for many short columns.
| Language | Code | Sidebar | Search | TOC | Status | |
|---|---|---|---|---|---|---|
| 简体中文 | zh |
✅ | ✅ | ✅ | ✅ | Reviewed |
| English | en |
✅ | ✅ | ✅ | ✅ | Reviewed |
Technical wide tables
.wide in OINK 1.4.0The short marker is included in the release. Existing technical-table markup remains supported.
Technical tables containing long configuration keys, environment variables, or
identifiers can produce awkward token breaks and very tall rows when forced into
the reading column. Adding {.wide .expand} to the attribute line opts the
inner table into natural intrinsic sizing (width: max-content), scrolling
horizontally within its wrapper when it exceeds the available space.
| Variable | Required | Default | Configuration key | Description |
|---|---|---|---|---|
HG_PD_GRPC_HOST |
Yes | None | grpc.host |
Advertised gRPC hostname/IP; use container hostnames within a container network. |
HG_PD_INITIAL_STORE_COUNT |
No | 1 |
pd.initial-store-count |
Minimum Store count needed for cluster availability. |
HG_PD_ACTUATOR_EXPOSURE |
No | health,metrics,prometheus |
management.endpoints.web.exposure.include |
Public Actuator endpoint allowlist; * is forbidden. |
Difference from .full-width
.full-widthcontrols the outer canvas: it expands the table container to break out of the reading column into the full width of the article layout. It suits tables with many short columns..widecontrols the inner table sizing: it sets the table to its natural intrinsic width (width: max-content), using horizontal scrolling to accommodate wide content. It suits tables with long technical identifiers.- Both can be combined:
{.full-width .wide}expands the container to the full canvas while allowing the inner table to keep its natural wide measure.
Applicability boundaries
- Explicit opt-in: Ordinary tables keep their existing layout. Only tables
marked
.wideuseoverflow-wrap: break-word,word-break: normal, and a softmax-width: 40chbody-cell bound. Very long tokens may still wrap; the bound is not a fixed column width. - Static outputs: This policy applies only on screen. Print and RSS use
static wrappers and retain their existing layout; Markdown preserves the authored
GFM table and attribute line. The marker has no effect on
.fieldsdefinition lists.
Expand selected tables
.expand in OINK 1.4.0The opt-in reader is included in the release.
Add .expand only to tables that benefit from a larger reading area. A small
expand icon sits at the top-right corner: desktop hover or keyboard focus reveals
it; touch devices keep it visible. Click once to open the table, then use Close
or Escape to return to the same reading position. Text size, links, and selection
stay intact; wide content still scrolls horizontally on small screens.
| Package | Version | Role |
|---|---|---|
pgvector |
0.8.1 |
Vector similarity search |
pg_stat_statements |
1.11 |
Statement statistics |
Goldmark accepts multiple classes: {.wide .expand} and
{class="wide expand"} are equivalent. Enable
markup.goldmark.parser.attribute.block: true and put the attribute line
immediately after the last row, without a blank line.
.wide controls layout; .expand enables the reading action. Either works alone.
You can also combine .expand with .full-width, .matrix, captions, numbering,
or tabs. There is no automatic size threshold or site-wide switch. The existing
.td-table--wide spelling remains compatible with .wide.
Only pages with opted-in tables load the small reader script. Without JavaScript,
a loaded script, or native dialog support, the complete inline table remains
readable without a dead button. Print and RSS keep static tables; Markdown keeps
the author syntax. Browser printing restores an open table to the article first.
Tables whose headers, aria-labelledby, or aria-describedby reference nodes
outside the table stay inline; custom styles depending on article ancestors
should be reviewed in the reader.
Field lists
{.fields} converts a table to a definition list. The first column is the name, the last is the description, and middle columns are metadata.
Use it for configuration keys, command flags, and API fields. See Fields for the complete syntax.
Numbered tables
For books or long manuals, add num, with optional #id and caption.
The theme wraps the table in a <figure> with a localized “Table N.” label and registers it as a Book target.
xref can reference it, and it appears in the book-wide table list.
Authors provide numbers. The theme never counts. id defaults to tbl-<num>.
| Isolation level | Dirty read | Non-repeatable read | Phantom read |
|---|---|---|---|
| Read committed | no | yes | yes |
| Repeatable read | no | no | yes |
| Serializable | no | no | no |
See Table 9-1.
Tables as tabs
Adjacent tables with {tab="…"} form a tab set, using the same rules as adjacent fences.
group on the first table enables URL hashes, synchronization, and saved selections. Each later table needs value.
See Tabs for the complete rules.
| Directory | Contents |
|---|---|
content/ |
Pages |
data/ |
Landing and release data |
| Directory | Contents |
|---|---|
assets/ |
SCSS and image resources |
static/ |
Files copied verbatim |
Output
| Output | Shape |
|---|---|
| HTML | A focusable <div class="td-table-scroll"> around the <table>; matrix and full-width are modifier classes on that wrapper |
| Complete static content with a keyboard-scrollable region in the browser preview; print-media CSS expands the region for paper output | |
| Markdown | The source table and its attribute line, emitted as written |
| RSS | The complete static table |
Ordinary tables load no script; .expand loads its reader only in HTML, and tabbed tables load the tabs runtime.
Parameter reference
The attribute line on the row below the table:
.fields, ,- Render as a definition list, see Fields
style, on*, and other keys warn and are ignored.
Limits
.fieldscannot be combined with.matrix,.full-width,.expand, ornum.numandtabare mutually exclusive.group/valuerequiretab, andmetarequires.fields.- The attribute line must immediately follow the table. A blank line makes the braces appear as text.
To prevent formatters moving the line, wrap it in
<!-- prettier-ignore-start -->/<!-- prettier-ignore-end -->. - GFM tables do not support merged cells, sorting, or filtering. Split complex tables with merged headers into two tables or use a matrix.
- Cells cannot contain block content. Use
fields/fieldshortcodes for multiple paragraphs, lists, or fences. .matrixcentering uses CSS. Explicit delimiter-row alignment takes precedence.
Related
- Fields — everything
{.fields}can do - Tabs — adjacent tables as a tab set
- Publishing books — numbered tables, cross references, the list of tables
- Code blocks — where attributes go on the info line instead of the next line