Default Component
By default, speak-mintlify uses theAudioTranscript component:
speaker-config.yaml
Component Structure
The audio component receives avoices prop with the following structure:
Default Component Features
The includedAudioTranscript component provides:
- Play/pause button with smooth transitions
- Progress bar with seeking
- Time display (current/total)
- Voice selector dropdown (when multiple voices configured)
- Dark mode support
- Responsive design
- Fish Audio S1 branding
Component Implementation
Here’s the full default component implementation:audio-transcript.jsx
Customizing the Component
You can create your own custom audio player component:1
Create your component
Create a custom React component in your Mintlify snippets folder:
snippets/custom-player.jsx
2
Update speaker-config.yaml
Configure speak-mintlify to use your custom component:
speaker-config.yaml
3
Regenerate audio
Run the generate command to update your MDX files:
Component Requirements
Your custom component must:- Accept a
voicesprop (array of{ name: string, url: string }) - Be a named export (not default export)
- Be compatible with Mintlify’s React environment
- Handle the case where
voicesis empty or undefined
Styling
The default component uses Tailwind CSS classes compatible with Mintlify’s theme. For custom styling:- Use Tailwind classes for consistency with Mintlify’s design
- Support both light and dark mode with
dark:variants - Use Mintlify’s CSS variables for colors (e.g.,
bg-card,text-muted-foreground)
CLI Overrides
You can override component settings via CLI:Next Steps
Speaker Config
Configure voices and settings
.speakignore
Exclude files from processing
