Skip to content

Update Lists and Tables page #877

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update Lists and Tables page #877

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 12 additions & 19 deletions list-table.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ description: "Display information in lists and tables"
icon: "list"
---


## Lists

### Ordered List
Lists follow the official [Markdown syntax](https://www.markdownguide.org/basic-syntax/#lists-1).

### Ordered list

To create an ordered list, add line items with numbers followed by periods
To create an ordered list, add numbers followed by a period before list items.

1. First item
2. Second item
Expand All @@ -23,9 +24,9 @@ To create an ordered list, add line items with numbers followed by periods
4. Fourth item
```

### Unordered List
### Unordered list

To create an unordered list, add dashes (`-`), asterisks (`*`), or plus signs (`+`) in front of line items.
To create an unordered list, add dashes (`-`), asterisks (`*`), or plus signs (`+`) before list items.

- First item
- Second item
Expand All @@ -39,9 +40,9 @@ To create an unordered list, add dashes (`-`), asterisks (`*`), or plus signs (`
- Fourth item
```

### Nested List
### Nested list

Add indents on list items to nest them
Indent list items to nest them.

- First item
- Second item
Expand All @@ -57,26 +58,18 @@ Add indents on list items to nest them
- Third item
```

<Tip>
Lists follow the official [markdown syntax](https://www.markdownguide.org/basic-syntax/#lists-1).
</Tip>

## 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 |

### Creating a table

<Tip>
The Table component follows the official [markdown syntax](https://www.markdownguide.org/extended-syntax/#tables).
</Tip>

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.

```mdx
| Property | Description |
| -------- | ------------------------------------- |
Expand Down