mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Hamed Rabah
110 lines
3.0 KiB
Plaintext
110 lines
3.0 KiB
Plaintext
---
|
|
title: "Lists and tables"
|
|
description: "Format structured data in your documentation with Markdown tables, ordered and unordered lists, nested structures, and task list checkboxes."
|
|
keywords: ["ordered", "unordered", "Markdown tables", "table formatting"]
|
|
---
|
|
|
|
## Lists
|
|
|
|
Lists follow the official [Markdown syntax](https://www.markdownguide.org/basic-syntax/#lists-1).
|
|
|
|
### Ordered list
|
|
|
|
To create an ordered list, add numbers followed by a period before list items.
|
|
|
|
1. First item
|
|
2. Second item
|
|
3. Third item
|
|
4. Fourth item
|
|
|
|
```mdx
|
|
1. First item
|
|
2. Second item
|
|
3. Third item
|
|
4. 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
|
|
|
|
```mdx
|
|
- 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
|
|
|
|
```mdx
|
|
- First item
|
|
- Second item
|
|
- Additional item
|
|
- Additional item
|
|
- Third item
|
|
```
|
|
|
|
## Tables
|
|
|
|
Tables follow the official [Markdown syntax](https://www.markdownguide.org/extended-syntax/#tables).
|
|
|
|
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.
|
|
|
|
| Property | Description |
|
|
| -------- | ------------------------------------- |
|
|
| Name | Full name of user |
|
|
| Age | Reported age |
|
|
| Joined | Whether the user joined the community |
|
|
|
|
```mdx
|
|
| Property | Description |
|
|
| -------- | ------------------------------------- |
|
|
| Name | Full name of user |
|
|
| Age | Reported age |
|
|
| Joined | Whether the user joined the community |
|
|
```
|
|
|
|
### 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.
|
|
|
|
| Value | Description |
|
|
| ------------- | --------------------------------- |
|
|
| `read\|write` | A value containing a literal pipe |
|
|
|
|
```mdx
|
|
| Value | Description |
|
|
| ------------- | --------------------------------- |
|
|
| `read\|write` | A value containing a literal pipe |
|
|
```
|
|
|
|
### Column alignment
|
|
|
|
Use colons in the separator row to align column content:
|
|
|
|
| Left aligned | Center aligned | Right aligned |
|
|
| :----------- | :------------: | ------------: |
|
|
| Left | Center | Right |
|
|
| Text | Text | Text |
|
|
|
|
```mdx
|
|
| Left aligned | Center aligned | Right aligned |
|
|
| :----------- | :------------: | ------------: |
|
|
| Left | Center | Right |
|
|
| Text | Text | Text |
|
|
```
|