Installation
Setup
Register the addon in your.storybook/main.ts:
Usage
Add notes to your stories using thenotes parameter:
Parameters
Markdown content to display in the Notes panel.Supports:
- Headings (
#,##,###, etc.) - Paragraphs
- Bold (
**text**), italic (_text_), strikethrough (~~text~~) - Code blocks with syntax highlighting
- Inline code (
`code`) - Links (
[text](url)) - Lists (ordered and unordered)
- Block quotes
- Horizontal rules (
---) - Tables
Markdown Support
The Notes addon usesreact-native-markdown-display for rendering, supporting most CommonMark features:
Headings
Text Formatting
Links
Lists
Code Blocks
Block Quotes
Horizontal Rules
Tables
Examples
Component Documentation
API Documentation
Usage Examples
Full Example with All Markdown Features
Themed Markdown
The Notes addon automatically applies your Storybook theme to markdown content:- Text colors adapt to light/dark mode
- Code blocks use theme colors
- Tables and borders match theme
- Links use the primary theme color
Per-Story Notes
Add different notes for each story:Combining with Other Addons
Notes work alongside other addons:Best Practices
- Keep it concise: Notes should enhance understanding, not overwhelm
- Use code examples: Show how to use the component
- Document edge cases: Explain unusual behavior or limitations
- Link to external docs: Reference full documentation when available
- Update with changes: Keep notes in sync with component updates