Skip to main content

Images, admonitions, and block quotes

ListTable supports rich content types that standard Markdown tables cannot handle.

Images in cells

Unlike standard Markdown tables, ListTable cells can contain images, icons, and diagrams.

HTTP status code categories
Code rangeIconCategoryDescription
2xxSuccess iconSuccessRequest succeeded
3xxRedirect iconRedirectionFurther action needed
4xxClient error iconClient errorRequest contains bad syntax
5xxServer error iconServer errorServer failed to fulfill valid request

MDX source

<ListTable headerRows={1} headerColumns={1} caption="HTTP status code categories" validation="strict">
- - Code range
- Icon
- Category
- Description
- - 2xx
- ![Success icon](/img/success.svg)
- Success
- Request succeeded
- - 3xx
- ![Redirect icon](/img/redirect.svg)
- Redirection
- Further action needed
...
</ListTable>

Admonitions in cells

Docusaurus admonitions (tip, info, warning, danger) work perfectly in ListTable cells.

Build configuration options
OptionDescriptionNotes
productionOptimized build for deployment
tip

Enable source maps for easier debugging in production

developmentFast rebuild with hot reload
info

Development mode includes helpful warnings and error messages

testConfigured for running tests
warning

Test mode may have different environment variables than production

debugVerbose logging enabled
danger

Never deploy with debug mode enabled - exposes sensitive information

MDX source

<ListTable headerRows={1} caption="Build configuration options" validation="strict">
- - Option
- Description
- Notes
- - `production`
- Optimized build for deployment
- :::tip
Enable source maps for easier debugging
:::
- - `development`
- Fast rebuild with hot reload
- :::info
Development mode includes helpful warnings
:::
</ListTable>

Block quotes in cells

Use block quotes for testimonials, quotes, or emphasized text.

Design system principles
PrincipleDescriptionQuote
ConsistencyUse established patterns throughout

"Consistency is one of the most powerful usability principles: when things always behave the same, users don't have to worry about what will happen."

— Jakob Nielsen

FeedbackInform users about system state

"The system should always keep users informed about what is going on, through appropriate feedback within reasonable time."

— Nielsen Norman Group

SimplicityMinimize cognitive load

"Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away."

— Antoine de Saint-Exupéry

MDX source

<ListTable headerRows={1} caption="Design system principles" validation="strict">
- - Principle
- Description
- Quote
- - Consistency
- Use established patterns throughout
- > "Consistency is one of the most powerful usability principles..."
>
> — Jakob Nielsen
- - Feedback
- Inform users about system state
- > "The system should always keep users informed..."
>
> — Nielsen Norman Group
</ListTable>

Combined rich content

Combine multiple content types in a single table for maximum expressiveness.

Database migration strategies
StrategyWhen to useExampleCaution

Blue-green deployment

Zero-downtime migrations

Diagram

Run two identical environments:

  • Blue (current version)
  • Green (new version)

Switch traffic after validation

warning

Requires 2x infrastructure during migration

Rolling migrationGradual feature rollout

"We migrated 50 million users over 6 weeks without a single outage."

— Platform Engineer, TechCorp

tip

Monitor error rates carefully during rollout

Big bang migrationSmall databases or maintenance windowsSteps:
  1. Take full backup
  2. Put application in maintenance mode
  3. Run migration scripts
  4. Verify data integrity
  5. Bring application back online
danger

High risk - only use for non-critical systems or when downtime is acceptable

MDX source

<ListTable headerRows={1} caption="Database migration strategies" validation="strict">
- - Strategy
- When to use
- Example
- Caution
- - Blue-green deployment
- Zero-downtime migrations
- ![Diagram](/img/blue-green.svg)

Run two identical environments...
- :::warning
Requires 2x infrastructure
:::
</ListTable>