名称: markdown-tables 用户可调用: false 描述: 在创建或格式化Markdown表格时使用。涵盖表格语法、对齐、转义和最佳实践。允许工具:

Read
Write
Edit
Grep
Glob

Markdown 表格

创建和格式化Markdown表格的全面指南。

基本表格语法

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Cell 1   | Cell 2   | Cell 3   |
| Cell 4   | Cell 5   | Cell 6   |

渲染为:

Header 1	Header 2	Header 3
Cell 1	Cell 2	Cell 3
Cell 4	Cell 5	Cell 6

列对齐

| Left     | Center   | Right    |
|:---------|:--------:|---------:|
| Left     | Center   | Right    |
| aligned  | aligned  | aligned  |

渲染为:

Left	Center	Right
Left	Center	aligned
text	text	text

:--- 左对齐（默认）
:--: 居中对齐
---: 右对齐

最小语法

管道和破折号不需要对齐:

|Header|Header|
|-|-|
|Cell|Cell|

但是，对齐的表格在源代码中更具可读性。

转义管道字符

使用 \| 在单元格中包含字面管道:

| Command | Description |
|---------|-------------|
| `a \| b` | 管道运算符 |
| `cmd \|\| exit` | 或运算符 |

表格中的行内格式化

表格支持行内Markdown:

| Feature | Syntax |
|---------|--------|
| **粗体** | `**text**` |
| *斜体* | `*text*` |
| `代码` | `` `code` `` |
| [链接](url) | `[text](url)` |

多行单元格内容

标准Markdown表格不支持多行单元格。解决方法:

使用 `<br>` 标签

| Step | Description |
|------|-------------|
| 1 | 第一行<br>第二行 |
| 2 | 另一个步骤 |

使用HTML表格

对于复杂布局，使用HTML:

<table>
  <tr>
    <th>Header</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>Item</td>
    <td>
      <ul>
        <li>点一</li>
        <li>点二</li>
      </ul>
    </td>
  </tr>
</table>

空单元格

使用空格或留空:

| A | B | C |
|---|---|---|
| 1 |   | 3 |
| 4 | 5 |   |

宽表格

对于多列表格，考虑:

滚动容器 (HTML)

<div style="overflow-x: auto;">

| Col 1 | Col 2 | Col 3 | Col 4 | Col 5 | Col 6 |
|-------|-------|-------|-------|-------|-------|
| Data  | Data  | Data  | Data  | Data  | Data  |

</div>

垂直布局

将宽表格转换为键值对:

### 项目 1

| Property | Value |
|----------|-------|
| Name     | Foo   |
| Type     | Bar   |
| Status   | Active |

常见表格模式

比较表格

| Feature | Free | Pro | Enterprise |
|---------|:----:|:---:|:----------:|
| Users   | 5    | 50  | Unlimited  |
| Storage | 1GB  | 10GB| 100GB      |
| Support | ❌   | ✅  | ✅         |

API 参考

| Parameter | Type | Required | Description |
|-----------|------|:--------:|-------------|
| `id`      | string | ✅ | 唯一标识符 |
| `name`    | string | ✅ | 显示名称 |
| `limit`   | number | ❌ | 最大结果（默认: 10） |

键盘快捷键

| Action | Windows/Linux | macOS |
|--------|---------------|-------|
| Copy   | `Ctrl+C`      | `⌘+C` |
| Paste  | `Ctrl+V`      | `⌘+V` |
| Undo   | `Ctrl+Z`      | `⌘+Z` |

变更日志

| Version | Date | Changes |
|---------|------|---------|
| 2.0.0 | 2024-01-15 | 破坏性: 新API |
| 1.2.0 | 2024-01-01 | 添加功能 X |
| 1.1.0 | 2023-12-15 | 错误修复 |

最佳实践

保持表格简单: 如果内容复杂，考虑替代方案
使用一致对齐: 对齐源代码管道以提高可读性
必需头部行: 始终包含头部行
转义特殊字符: 使用 \| 处理字面管道
限制列数: 宽表格难以阅读
考虑替代方案: 列表或定义列表可能更合适
测试渲染: 表格在不同平台渲染不同

Markdownlint 表格规则

Rule	Description
MD055	表格管道风格应一致
MD056	表格列数应匹配头部
MD058	表格周围应有空行

表格的替代方案

定义列表（某些解析器）

术语 1
: 定义 1

术语 2
: 定义 2

带粗体键的列表

- **Name**: John Doe
- **Email**: john@example.com
- **Role**: Developer

嵌套列表

- Item 1
  - Property A: Value
  - Property B: Value
- Item 2
  - Property A: Value
  - Property B: Value