Tables

Tables help present structured data in an easy-to-read format.

Basic Table Syntax

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 |
| Row 2 Col 1 | Row 2 Col 2 | Row 2 Col 3 |

Rendered:

Column Alignment

Use colons (:) in the separator row to control alignment:

| Left Aligned | Center Aligned | Right Aligned |
|:-------------|:--------------:|--------------:|
| Default | Text | Numbers |
| Left | Center | Right |
| Content | Centered | 1000 |

Rendered:

Practical Examples

Feature Comparison

| Feature | Free | Pro | Enterprise |
|---------|:----:|:---:|:----------:|
| Users | 5 | 25 | Unlimited |
| Storage | 1GB | 100GB | Unlimited |
| Support | Email | Priority | 24/7 Phone |
| API Access | ❌ | ✅ | ✅ |
| Custom Domain | ❌ | ✅ | ✅ |
| SSO | ❌ | ❌ | ✅ |

Rendered:

API Endpoints

| Method | Endpoint | Description |
|--------|----------|-------------|
| GET | `/api/users` | List all users |
| GET | `/api/users/{id}` | Get user by ID |
| POST | `/api/users` | Create new user |
| PUT | `/api/users/{id}` | Update user |
| DELETE | `/api/users/{id}` | Delete user |

Rendered:

Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|:--------:|---------|-------------|
| `name` | string | Yes | - | User's full name |
| `email` | string | Yes | - | User's email address |
| `role` | string | No | `user` | User role: admin, user, guest |
| `active` | boolean | No | `true` | Account status |
| `age` | integer | No | `null` | User's age |

Rendered:

Status Codes

| Code | Status | Description |
|-----:|--------|-------------|
| 200 | OK | Request successful |
| 201 | Created | Resource created successfully |
| 400 | Bad Request | Invalid request parameters |
| 401 | Unauthorized | Authentication required |
| 403 | Forbidden | Insufficient permissions |
| 404 | Not Found | Resource not found |
| 500 | Server Error | Internal server error |

Rendered:

Version Compatibility

| Feature | v1.x | v2.x | v3.x |
|---------|:----:|:----:|:----:|
| Basic Auth | ✅ | ✅ | ✅ |
| OAuth 2.0 | ❌ | ✅ | ✅ |
| Webhooks | ❌ | ✅ | ✅ |
| GraphQL | ❌ | ❌ | ✅ |
| Rate Limiting | ❌ | ✅ | ✅ |
| Batch Requests  | ❌ | ❌ | ✅ |

Rendered:

Configuration Options

| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `timeout` | integer | `30` | Request timeout in seconds |
| `retry` | boolean | `true` | Auto-retry failed requests |
| `max_retries` | integer | `3` | Maximum retry attempts |
| `cache` | boolean | `false` | Enable response caching |
| `debug` | boolean | `false` | Enable debug mode |

Rendered:

Pricing Table

| Plan | Monthly | Annual | Savings |
|------|--------:|-------:|--------:|
| Starter | $9 | $90 | 17% |
| Professional | $29 | $290 | 17% |
| Business | $99 | $990 | 17% |
| Enterprise | Custom | Custom | - |

Rendered:

Using Inline Code in Tables

| Variable | Example | Description |
|----------|---------|-------------|
| `APP_ENV` | `production` | Application environment |
| `APP_DEBUG` | `false` | Debug mode toggle |
| `APP_URL` | `https://example.com` | Application URL |

Rendered:

Using Links in Tables

| Resource | Link | Description |
|----------|------|-------------|
| Documentation | [Docs](/) | Official documentation |
| GitHub | [Repository](https://github.com/user/repo) | Source code |
| Support | [Contact](mailto:[email protected]) | Get help |

Rendered:

Using Emoji and Icons

| Status | Icon | Meaning |
|--------|:----:|---------|
| Success | ✅ | Operation completed |
| Error | ❌ | Operation failed |
| Warning | ⚠️ | Proceed with caution |
| Info | ℹ️ | Additional information |
| Pending | ⏳ | In progress |

Rendered:

Table Best Practices

1. Keep Tables Readable

Good:

| ID | Name | Email |
|----|------|-------|
| 1 | John | [email protected] |
| 2 | Jane | [email protected] |

Avoid:

| ID | Name | Email | Address | Phone | Department | Manager | Start Date | End Date | Status |
|----|------|-------|---------|-------|------------|---------|------------|----------|--------|
| 1 | John Doe | [email protected] | 123 Main St, Apt 4B, New York, NY 10001 | +1-555-0123 | Engineering | Sarah Smith | 2020-01-15 | Current | Active |

2. Align Appropriately

| Type | Alignment | Example |
|------|-----------|---------|
| Text | Left | Default |
| Numbers | Right | 1,234.56 |
| Icons | Center | ✅ |
| Code | Left | `function()` |

Rendered:

3. Use Headers Effectively

| Property | Value | Notes |
|----------|-------|-------|
| `max_connections` | 100 | Maximum database connections |
| `timeout` | 30 | Connection timeout (seconds) |
| `pool_size` | 10 | Connection pool size |

Clear headers help users understand the data structure.

4. Keep Cell Content Concise

Good:

| Feature | Status |
|---------|--------|
| API | Available |
| CLI | Beta |
| GUI | Planned |

Avoid:

| Feature | Status |
|---------|--------|
| The REST API interface for programmatic access | Currently available in production |
| Command line interface tool for terminal users | Currently in beta testing phase |
| Graphical user interface for desktop | Planned for future release |

5. Add Context Above Table

Provide context before complex tables:

The following table shows supported authentication methods:

| Method | Security Level | Use Case |
|--------|:--------------:|----------|
| API Key | Basic | Simple integrations |
| OAuth 2.0 | High | Third-party apps |
| JWT | High | Single page apps |

Alternatives to Tables

For very complex data, consider alternatives:

Definition Lists

**API Key**
: Simple authentication for server-side applications
: Security Level: Basic

**OAuth 2.0**
: Industry-standard authorization framework
: Security Level: High

Nested Lists

### Authentication Methods

- **API Key**
  - Security: Basic
  - Use Case: Simple integrations
  - Rate Limit: 1000/hour

- **OAuth 2.0**
  - Security: High
  - Use Case: Third-party apps
  - Rate Limit: 5000/hour

Code Blocks

For configuration examples:

authentication:
  api_key:
    security: basic
    rate_limit: 1000
  oauth2:
    security: high
    rate_limit: 5000

Common Table Patterns

Keyboard Shortcuts

| Key | Action |
|-----|--------|
| `Ctrl + S` | Save document |
| `Ctrl + C` | Copy selection |
| `Ctrl + V` | Paste |
| `Ctrl + Z` | Undo |
| `Ctrl + Shift + Z` | Redo |

Changelog

| Version | Date | Changes |
|---------|------|---------|
| 3.2.1 | 2026-02-10 | Bug fixes and improvements |
| 3.2.0 | 2026-02-01 | New dashboard, API v3 |
| 3.1.0 | 2026-01-15 | Performance upgrades |

Environment Variables

| Variable | Required | Default | Description |
|----------|:--------:|---------|-------------|
| `DB_HOST` | Yes | - | Database hostname |
| `DB_PORT` | No | `3306` | Database port |
| `DB_NAME` | Yes | - | Database name |

File Structure

| Path | Type | Description |
|------|------|-------------|
| `/app` | Directory | Application code |
| `/config` | Directory | Configuration files |
| `/public` | Directory | Public assets |
| `/routes/web.php` | File | Web routes |

Limitations

Not Supported:

• Cell merging (rowspan/colspan)
• Multi-line content in cells
• Nested tables
• Cell background colors
• Complex formatting

For advanced table features, use HTML:

<table>
  <tr>
    <th rowspan="2">Feature</th>
    <th colspan="2">Version Support</th>
  </tr>
  <tr>
    <th>v2</th>
    <th>v3</th>
  </tr>
  <tr>
    <td>API</td>
    <td>✅</td>
    <td>✅</td>
  </tr>
</table>

Next Steps

• View code examples
• Learn about navigation
• Explore all features