Skip to main content
The speaker-config.yaml file is the central configuration file for speak-mintlify. It defines voice mappings and component settings for your documentation.

​
File Location

Place speaker-config.yaml in the root of your documentation directory (the same directory you run speak-mintlify from).

​
Configuration Structure

​
Voices

The voices section maps Fish Audio voice IDs to friendly display names:
speaker-config.yaml
Voice IDs come from Fish Audio. Each voice ID is a unique identifier for a TTS voice.

​
Component Settings

The component section configures the audio player that gets injected into your MDX files:
speaker-config.yaml
Options:
  • import - The import path for your audio player component (relative to your Mintlify docs root)
  • name - The component name used in the MDX import statement

​
Full Example

speaker-config.yaml

​
Configuration Priority

speak-mintlify uses the following priority order for configuration:
  1. CLI flags (highest priority)
  2. Environment variables
  3. speaker-config.yaml
  4. Defaults (lowest priority)
This means you can override YAML settings with CLI flags or environment variables.
Keep sensitive credentials (API keys, S3 secrets) in .env or environment variables, not in speaker-config.yaml.

​
CLI Overrides

You can override voice configuration via CLI flags:
Component settings can also be overridden:

​
Next Steps

Environment Variables

Configure API keys and S3 credentials

Audio Component

Customize the audio player component