GitHub README 表格最佳实践

为什么在 README 中使用表格？

表格能够帮助你以清晰、结构化的方式展示 API 参数、配置选项、功能对比等信息，让项目文档更易阅读。

API 参数表格示例

| Parameter | Type    | Required | Default | Description          |
|-----------|---------|----------|---------|----------------------|
| name      | string  | yes      | -       | User's display name  |
| email     | string  | yes      | -       | User's email address |
| role      | string  | no       | "user"  | User role            |
| active    | boolean | no       | true    | Account status       |

功能对比表格

| Feature        | Free  | Pro   | Enterprise |
|:---------------|:-----:|:-----:|:----------:|
| Projects       | 3     | ∞     | ∞          |
| Team members   | 5     | 25    | ∞          |
| Storage        | 1 GB  | 10 GB | 100 GB     |
| Custom domain  | ✗     | ✓     | ✓          |

快速创建 README 表格

使用 Markdown Table Toolkit 可视化编辑器，快速创建完美格式的 README 表格。

打开编辑器