Skip to content

Markdown versions of all docs pages are available by appending .md to any docs URL.

table

Page as Markdown

Wraps a markdown table so the author picks how its columns size

Either call form works, and both produce identical HTML.

Parameters

Named

NameTypeRequiredDefaultDescription
modestringnowrapOne of wrap, nowrap, or equal. See Notes.

Positional

NameTypeRequiredDefaultDescription
0stringnowrapPositional alias for mode.

Example

{{% table mode="nowrap" %}}
| Command | Description |
| ------- | ----------- |
| `kubectl get pods -n agentgateway -o wide` | Lists pods. |
{{% /table %}}
Rendered output
CommandDescription
kubectl get pods -n agentgateway -o wideLists pods.

Notes

This is the REFERENCE IMPLEMENTATION of the header contract in MAINTAINING.md. If the two disagree, the document is right and this file needs updating.

The three modes:

  • wrap (default) fills the body width and wraps content as needed, never scrolling horizontally. Best for prose and description tables, and for small two-column tables that should span the page.
  • nowrap sizes each column to its content and never wraps, scrolling horizontally when the table is wider than the body. Best for code snippets and command tables, where wrapping hurts reading.
  • equal gives equal-width columns via table-layout: fixed, and wraps content. Best when columns should be uniform regardless of content.

Without this shortcode the theme applies a column-count heuristic that caps cell width only on reference tables of three or more columns. Reach for table when that default does not suit a specific table.

The markdown table must start at column 0. .InnerDeindent strips a uniform leading indent, but ragged indentation still breaks the table.

The inner markdown goes through .Page.RenderString so both call forms produce identical HTML. That is not cosmetic: the rebase pipeline rewrites percent-form shortcodes to angle-bracket form, so anything relying on percent-form splice-back semantics breaks on a rebased page. Same reasoning as github-table.html.


Source: layouts/_shortcodes/table.html

Was this page helpful?