Tables
Tables make complex information easier to understand by presenting it in a clear structure.
The purpose of a table is to provide a scannable content experience.
Use tables for:
- Simple mappings of data and values
- Categories of things with examples
- Collections of things with different attributes
Each cell within a table should not contain more than one sentence of content.
We use standard Markdown tables for our documentation.
| Category | Range |
|---|---|
| Not computed | Bot scores of 0. |
| Automated | Bot scores of 1. |
| Likely automated | Bot scores of 2 through 29. |
| Likely human | Bot scores of 30 through 99. |
| Verified bot | Non-malicious automated traffic (used to power search engines and other applications). |
| Category | Range || ---- | ---- || **Not computed** | Bot scores of 0. || **Automated** | Bot scores of 1. || **Likely automated** | Bot scores of 2 through 29. || **Likely human** | Bot scores of 30 through 99. || **Verified bot** | Non-malicious automated traffic (used to power search engines and other applications). |When using tables:
- Check whether the tables work for both desktop and mobile users.
- Limit tables to three columns (or four if the information is very condensed).
- Avoid long sentences or information that is so dense that it defeats the purpose of having tabular displays
-
Introduce tables with a complete sentence that describes the purpose of the table because not all screen readers preannounce tables. The introductory sentence can end with a colon or a period; usually a colon if it immediately precedes the table, and usually a period if there's more material (such as a note paragraph) between the introduction and the table.
If your information does not fit within the guidelines, consider using the following methods of presentation:
As stated in the guidelines, we generally avoid large tables in our documentation.
However, if you have a unique use case, use the {{</*table-wrap*/>}} shortcode to make your table responsive and scrollable.
| Header 1 | Header 2 | Header 3 | Header 4 |
|---|---|---|---|
| test | test | test | test |
{{</*table-wrap*/>}}
| Header 1 | Header 2 | Header 3 | Header 4 || --- | --- | --- | --- || test | test | test | test |
{{</*/table-wrap*/>}}