Lists
Lists follow the official Markdown syntax.Ordered list
To create an ordered list, add numbers followed by a period before list items.- First item
- Second item
- Third item
- Fourth item
Unordered list
To create an unordered list, add dashes (-), asterisks (*), or plus signs (+) before list items.
- First item
- Second item
- Third item
- Fourth item
Nested list
Indent list items to nest them.- First item
- Second item
- Additional item
- Additional item
- Third item
Task list
To create a task list, add[ ] for an unchecked checkbox or [x] for a checked checkbox after unordered list markers.
- Completed item
- Incomplete item
Tables
Tables follow the official Markdown syntax. To add a table, use three or more hyphens (---) to create each column’s header, and use pipes (|) to separate each column. For compatibility, you should also add a pipe on either end of the row.
Escape pipe characters
To include a literal pipe character (|) in a table cell, prefix it with a backslash (\|). Escape pipe characters even when they appear inside inline code. Otherwise, the pipe is treated as a column separator and can cause parsing errors during preview or validation.
Column alignment
Use colons in the separator row to align column content:Column widths
Markdown tables size their columns automatically based on content. To control column widths, write the table in HTML and add a<colgroup> element that sets a width on every <col>.
When every <col> declares a width, through the width attribute or an inline style, the table uses your widths and wraps long content within each column. If any <col> is missing a width, Mintlify ignores the declared widths and sizes columns based on content. Tables that are too wide for the page scroll horizontally.
| Parameter | Type | Description |
|---|---|---|
| name | string | Full name of the user |
| age | number | Reported age of the user |