Table
Tables are configured using a combination of | pipe characters to separate columns and at least three --- dashes to separate the header row from the table body.
The following sample demonstrates a basic table configuration and the default style:
Project | Status | Owner
--- | --- | ---
Website Redesign | [!badge Review] | Operations
Quarterly Forecast | [!badge Approved|success] | Finance
Customer Onboarding | [!badge Draft|secondary] | Product
The above configuration creates the following table:
The | pipe character column separators are not required to vertically align. Extra whitespace within the column widths is ignored and the result will look the same.
Project | Status | Owner
--- | --- | ---
Website Redesign | [!badge Review] | Operations
Quarterly Forecast | [!badge Approved|success] | Finance
Customer Onboarding | [!badge Draft|secondary] | Product
Clean
Apply the clean class to remove the table borders.
{.clean}
Project | Status | Owner
--- | --- | ---
Website Redesign | [!badge Review] | Operations
Quarterly Forecast | [!badge Approved|success] | Finance
Customer Onboarding | [!badge Draft|secondary] | Product
Striped
Apply the striped class to alternate the background color of body rows.
Default
{.striped}
Project | Status | Owner
--- | --- | ---
Website Redesign | [!badge Review] | Operations
Quarterly Forecast | [!badge Approved|success] | Finance
Customer Onboarding | [!badge Draft|secondary] | Product
Clean
{.clean .striped}
Project | Status | Owner
--- | --- | ---
Website Redesign | [!badge Review] | Operations
Quarterly Forecast | [!badge Approved|success] | Finance
Customer Onboarding | [!badge Draft|secondary] | Product
Compact
Apply the compact class to reduce the cell padding and text size.
Default
{.compact}
Project | Status | Owner
--- | --- | ---
Website Redesign | [!badge Review] | Operations
Quarterly Forecast | [!badge Approved|success] | Finance
Customer Onboarding | [!badge Draft|secondary] | Product
Clean
{.clean .compact}
Project | Status | Owner
--- | --- | ---
Website Redesign | [!badge Review] | Operations
Quarterly Forecast | [!badge Approved|success] | Finance
Customer Onboarding | [!badge Draft|secondary] | Product
Striped + Compact
The striped and compact classes can be combined in both default and clean table styles.
Default
{.striped .compact}
Project | Status | Owner
--- | --- | ---
Website Redesign | [!badge Review] | Operations
Quarterly Forecast | [!badge Approved|success] | Finance
Customer Onboarding | [!badge Draft|secondary] | Product
Clean
{.clean .striped .compact}
Project | Status | Owner
--- | --- | ---
Website Redesign | [!badge Review] | Operations
Quarterly Forecast | [!badge Approved|success] | Finance
Customer Onboarding | [!badge Draft|secondary] | Product
Alignment
The alignment of text within a column can be configured by using the : colon character within the header separator row.
By default, text is left aligned. To center align text, use :---: with colons at both ends of the header separator. To right align text, use ---: with a colon on the right end of the header separator.
Project | Status | Owner
:--- | :---: | ---:
Website Redesign | [!badge Review] | Operations
Quarterly Forecast | [!badge Approved|success] | Finance
Customer Onboarding | [!badge Draft|secondary] | Product
Column widths are calculated dynamically by the web browser and will vary depending on the content of the cells.
Equal
Apply the equal class to distribute the table width evenly across columns.
{.equal}
Project | Status | Owner
--- | --- | ---
Website Redesign | [!badge Review] | Operations
Quarterly Forecast | [!badge Approved|success] | Finance
Customer Onboarding | [!badge Draft|secondary] | Product
Nowrap
The whitespace-nowrap class prevents text within table cells from wrapping to the next line, keeping all content on a single line. This is useful for maintaining the layout of content that should stay on one line, such as code snippets or long strings.
{.whitespace-nowrap}
Name | Long Message | Description
--- | --- | ---
Item 1 | This is an extra long message that should not wrap in the table | This is a description
Item 2 | Another long content item | Another description
Item 3 | A third example with similarly long content on one line | A final description
You can also apply multiple custom CSS classes to combine formatting options:
{.whitespace-nowrap .compact}
Name | Long Message | Description
--- | --- | ---
Item 1 | This is an extra long message that should not wrap in the table | This is a description
Item 2 | Another long content item | Another description
Item 3 | A third example with similarly long content on one line | A final description