列表与表格

使用 Markdown 表格、有序列表、无序列表、嵌套结构和任务列表复选框在文档中呈现结构化数据。

列表

列表遵循官方的 Markdown 语法。

有序列表

要创建有序列表，请在每个列表项前加上数字和一个句点。

第一项
第二项
第三项
第四项

1. 第一项
2. 第二项
3. 第三项
4. 第四项

无序列表

要创建无序列表，在列表项前添加连字符（-）、星号（*）或加号（+）。

第一项
第二项
第三项
第四项

- 第一项
- 第二项
- 第三项
- 第四项

嵌套列表

通过缩进列表项来创建嵌套。

第一项
第二项
- 附加项
- 附加项
第三项

- 第一项
- 第二项
  - 附加项
  - 附加项
- 第三项

任务列表

要创建任务列表，在无序列表标记后添加 [ ] 表示未勾选的复选框，或添加 [x] 表示已勾选的复选框。

已完成项
未完成项

- [x] 已完成项
- [ ] 未完成项

表格

表格遵循官方的 Markdown 语法。

要添加表格，使用三个或更多连字符（---）来创建每一列的表头，并使用竖线（|）分隔每一列。为兼容起见，还应在每行的两端各添加一个竖线。

属性	说明
名称	用户全名
年龄	用户填写的年龄
加入	该用户是否已加入社区

| Property | 说明                           |
| -------- | ------------------------------------- |
| Name     | 用户全名                     |
| Age      | 年龄                          |
| Joined   | 用户是否已加入社区 |

转义竖线字符

要在表格单元格中包含字面量竖线字符（|），请在其前面加上反斜杠（\|）。即使竖线字符出现在行内代码中，也需要转义。否则，竖线会被视为列分隔符，可能在预览或验证时导致解析错误。

值	说明
`read\|write`	包含字面量竖线的值

| Value         | Description                       |
| ------------- | --------------------------------- |
| `read\|write` | A value containing a literal pipe |

列对齐

在分隔行中使用冒号来设置列内容的对齐方式：

左对齐	居中对齐	右对齐
左	中	右
文本	文本	文本

| 左对齐 | 居中对齐 | 右对齐 |
| :----------- | :------------: | ------------: |
| 左对齐         | 居中对齐         | 右对齐         |
| 文本         | 文本           | 文本          |

列宽

Markdown 表格会根据内容自动调整列宽。要控制列宽，请使用 HTML 编写表格，并添加一个为每个 <col> 设置宽度的 <colgroup> 元素。

在编辑器的可视化模式中，拖动列边框即可调整列宽。编辑器会自动将表格转换为 HTML 并写入 <colgroup> 宽度。

当每个 <col> 都通过 width 属性或内联样式声明宽度时，表格会使用你设置的宽度，并在每列内换行显示过长的内容。如果任何 <col> 缺少宽度，Mintlify 会忽略声明的宽度并根据内容调整列宽。超出页面宽度的表格仍然可以水平滚动。

参数	类型	描述
name	string	用户的全名
age	number	用户报告的年龄

<table>
  <colgroup>
    <col width="25%" />
    <col width="15%" />
    <col width="60%" />
  </colgroup>
  <thead>
    <tr>
      <th>Parameter</th>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>name</td>
      <td>string</td>
      <td>Full name of the user</td>
    </tr>
    <tr>
      <td>age</td>
      <td>number</td>
      <td>Reported age of the user</td>
    </tr>
  </tbody>
</table>

On this page