Panel
Replace the Table of Contents with custom sidebar content
The Panel component allows you to display custom content in the right sidebar instead of the default Table of Contents.
This note is displayed in the sidebar panel!
Scroll down to see the panel stays visible.
Basic Usage
Wrap any content in a Panel to have it appear in the right sidebar:
<Panel>
<Info>This content appears in the sidebar!</Info>
</Panel>
Example: Pinned Information
Keep important information visible as users scroll through content:
<Panel>
<Warning>
API rate limits apply.
</Warning>
<Info>
Need help? Contact support@example.com
</Info>
</Panel>
Example: Quick Reference Card
Display a summary alongside detailed content:
<Panel>
<Card title="Quick Reference" icon="list">
Endpoints: GET, POST, PUT, DELETE
</Card>
</Panel>
Behavior
- Panel content appears in the right sidebar on desktop (1280px and above)
- On smaller screens, Panel content is hidden (same as Table of Contents)
- Only one Panel per page is supported
- The Panel replaces the Table of Contents entirely
Supported Content
You can place any component inside a Panel:
- Callouts (Note, Warning, Info, Tip, Check, Danger)
- Cards (Card, CardGroup)
- Code examples (RequestExample, ResponseExample, CodeGroup)
- Accordions
- Any other MDX component or markdown content
