Skip to main content

Documentation Index

Fetch the complete documentation index at: https://learn.mintlify.com/llms.txt

Use this file to discover all available pages before exploring further.

Tables communicate relationships between items and attributes. A reader can scan a column to understand all the values for one attribute, or scan a row to understand everything about one option. However, tables only work if the content actually has that structure. Using tables when the information isn’t tabular can make it harder to understand or introduce accessibility issues.

​
When are tables the right choice?

Tables work well when:
  • You have multiple items (rows) with the same set of attributes (columns)
  • Each cell has a short, scannable value. Don’t put paragraphs of prose in table cells.
  • The comparison is the point, not the individual items.
Examples of when to use tables:
  • Feature comparison by plan tier
  • Supported SDK languages by feature
  • API parameters with name, type, default, and description columns
  • Operating system requirements
Environment requirements table
| Environment | Minimum version | Notes |
|-------------|----------------|-------|
| Node.js     | 18.0           | LTS recommended |
| Python      | 3.9            | |
| Ruby        | 3.1            | |
| Go          | 1.21           | |

​
When are tables the wrong choice?

Trying to force non-tabular information into a table is the most common problem. There must be a relationship between the table rows, headers, and cells. If there isn’t, don’t use a table. Uneven cell content can be difficult to read. If some cells are two words and others are two paragraphs, the table stops being scannable. Pull the long content into a separate section and use the table for the short summary. Tables with more than five or six columns start to break on mobile screens. Consider whether some columns could be collapsed, removed, or moved to a detail section. Tables aren’t good for narrative content. If you expect someone to read every word in a table in a particular order, it isn’t actually a table. Similarly, don’t try to put complex conditional logic in a table cell. If your table cell says “See note 3 below,” reconsider how you’re structuring the information. If cells need bullet lists, code blocks, or multiple paragraphs, use a different structure.

​
Alternatives to tables

When a table is almost right but doesn’t quite fit, consider these alternatives:
  • Two or three items with many attributes: consider cards organized with <Columns>.
  • Many items, few attributes: a bulleted list may be simpler.
  • Comparison where one option is clearly recommended: state the recommendation in prose and use a table only to show the key differences
Next up: Columns and cards for visual comparisons — When you need layout flexibility that tables don’t provide.