Skip to main content

Multi-line text

Cell content can include line breaks, formatting, and complex text structures.

Basic multi-line content

As with vanilla Markdown tables, you can use a backslash at the end of a line to force a line break without making a new paragraph.

Server configuration
ComponentConfigurationNotes
Web ServerPort: 8080
Host: 0.0.0.0
SSL: Enabled
Production ready
DatabaseType: PostgreSQL
Version: 14.2
Pool: 20 connections
Requires backup config
CacheType: Redis
Memory: 2GB
Eviction: LRU
Monitor memory usage

MDX source

<ListTable headerRows={1} caption="Server configuration">
- - Component
- Configuration
- Notes
- - Web Server
- Port: 8080\
Host: 0.0.0.0\
SSL: Enabled
- Production ready
...
</ListTable>

Lists in Cells

You can put ordered or unordered lists inside a table cell. To put a list in a table cell, use regular Markdown syntax for the content of the cell. In this case, the first two levels of the list define the table, while the third level of the list defines a list inside a table cell.

Feature comparison
PlanFeaturesPrice
Starter
  • 5 projects
  • 1 GB storage
  • Email support
$9/month
Professional
  • Unlimited projects
  • 50 GB storage
  • Priority support
  • Advanced analytics
  • API access
$29/month
Enterprise
  • Everything in Pro
  • Unlimited storage
  • 24/7 phone support
  • Custom integrations
  • SLA guarantee
Custom

MDX source

<ListTable headerRows={1} caption="Feature comparison">
- - Plan
- Features
- Price
- - Starter
- - 5 projects
- 1 GB storage
- Email support
- $9/month
- - Professional
- - Unlimited projects
- 50 GB storage
- Priority support
- Advanced analytics
- API access
- $29/month
- - Enterprise
- - Everything in Pro
- Unlimited storage
- 24/7 phone support
- Custom integrations
- SLA guarantee
- Custom
</ListTable>

Long descriptions

To put paragraphs breaks inside a table cell, leave a blank line between lines of text, just as you would in normal Markdown. You can use a mix of line breaks and paragraph breaks in the same cell.

API endpoints
EndpointDescriptionAuthentication

POST /api/users

Creates a new user account

Request Body:

  • name (required)
  • email (required)
  • password (required)

Returns:
User object with generated ID and auth token

API Key required

GET /api/users/:id

Retrieves user information

Parameters:

  • id: User ID (UUID)

Returns:
User object (excludes password)

Bearer token or API Key

DELETE /api/users/:id

Permanently deletes a user

Warning: This action cannot be undone.
All associated data will be removed.

Returns: 204 No Content on success

Bearer token (admin only)

MDX source

<ListTable headerRows={1} caption="API endpoints">
- - Endpoint
- Description
- Authentication
- - `POST /api/users`
- Creates a new user account

**Request Body:**

- name (required)
- email (required)
- password (required)

**Returns:**\
User object with generated ID and auth token
- API Key required
- - `GET /api/users/:id`
- Retrieves user information

**Parameters:**
- id: User ID (UUID)

**Returns:**\
User object (excludes password)
- Bearer token or API Key
- - `DELETE /api/users/:id`
- Permanently deletes a user

**Warning:** This action cannot be undone.\
All associated data will be removed.

**Returns:**\
204 No Content on success
- Bearer token (admin only)
</ListTable>