Skip to main content

Add voice narration to your documentation

Automatically generate high-quality text-to-speech audio for your Mintlify docs. Drive developer engagement and improve accessibility with natural-sounding voices.

Get StartedView Commands
Terminal

Quick Start

Get voice narration running on your docs in minutes.

1

Install speak-mintlify

Install the CLI tool using npm, yarn, or pnpm.
npm install -g speak-mintlify
2

Configure your voices and S3 storage

Create a speaker-config.yaml file to define your voices and set up environment variables for Fish Audio API and S3 storage.
speaker-config.yaml
voices:
  8ef4a238714b45718ce04243307c57a7: E-girl
  bf322df2096a46f18c579d0baa36f41d: Adrian

component:
  import: /snippets/audio-transcript.jsx
  name: AudioTranscript
Get your Fish Audio API key from Fish Audio. S3-compatible storage includes Cloudflare R2, MinIO, and AWS S3.
3

Generate audio for your docs

Run the generate command to create TTS audio for all your MDX files.
npx speak-mintlify generate .
The CLI will extract text from your MDX files, generate audio using Fish Audio, upload to S3, and inject audio player components automatically.

Key Features

Everything you need to add voice narration to your documentation.

Smart Caching

Hash-based caching regenerates audio only when content changes, saving API costs and build time.

Multiple Voices

Support multiple voices with easy YAML configuration. Perfect for different content types or languages.

S3 Compatible

Upload to Cloudflare R2, MinIO, AWS S3, or any S3-compatible storage provider.

Auto Injection

Automatically inject audio player components into your MDX files with proper metadata.

CI/CD Ready

Integrate seamlessly into GitHub Actions or any CI/CD pipeline with dry-run mode.

Cleanup Orphans

Remove unused audio files from S3 to keep storage costs low and maintain a clean bucket.

Explore by Topic

Dive deeper into configuration, commands, and integration guides.

🎙️

Configuration

Configure voices, environment variables, and audio components for your documentation.

Learn more
⚡

CLI Commands

Master the generate and cleanup commands with all available options and flags.

View commands
🚀

CI/CD Integration

Automate voice generation in GitHub Actions or your preferred CI/CD pipeline.

View guide
📚

API Reference

TypeScript type definitions and architecture documentation for developers.

Explore reference

Ready to add voice to your docs?

Get started with speak-mintlify in minutes. Generate high-quality voice narration powered by Fish Audio.

Get Started Now

Build docs developers (and LLMs) love

Get started for freeTalk to us