Documentation Best Practices

MDX documentation

Use MDX to write rich, interactive documentation pages that combine Markdown text with live component examples.

MDX documentation page

Here's an example of a documentation page in MDX format.

# Button Component

The Button component is used for user interactions.

## Usage

<Canvas of={ButtonStories.Primary} />

## Props

<ArgTypes of={Button} />

API documentation

Automatically generate prop tables and API documentation using JSDoc comments and the DocsPage feature.