Skip to main content
speak-mintlify is distributed as an npm package and requires Node.js 18.0.0 or higher.

​
Requirements

Before installing, ensure you have:
  • Node.js 18.0.0 or higher
  • npm, yarn, or pnpm package manager
  • A Mintlify documentation project
You can check your Node.js version: 
node --version
speak-mintlify uses ES modules and requires Node.js 18+ for full compatibility.

​
Package manager installation

Choose your preferred package manager to install speak-mintlify: 
npm install speak-mintlify
This installs speak-mintlify as a project dependency in your documentation repository.

​
Global installation

If you want to use speak-mintlify across multiple projects, install it globally: 
npm install -g speak-mintlify
After global installation, you can run speak-mintlify from anywhere: 
speak-mintlify generate /path/to/docs

​
Using npx (no installation)

You can run speak-mintlify without installing it using npx: 
npx speak-mintlify generate .
This downloads and executes the latest version of speak-mintlify. It’s perfect for:
  • One-time use or testing
  • CI/CD pipelines where you want the latest version
  • Avoiding dependency management
npx always fetches the latest version unless you specify a version: npx speak-mintlify@1.1.3

​
Local vs global installation

Choosing between local and global installation depends on your use case: Pros:
  • Version pinned in package.json for consistency across team
  • Works seamlessly with CI/CD
  • Different projects can use different versions
  • Part of your project’s dependency tree
Cons:
  • Need to use npx speak-mintlify or add npm scripts
  • Installed separately for each project
Best for: Team projects, CI/CD automation, version consistency

​
Global installation

Pros:
  • Run speak-mintlify directly from anywhere
  • Single installation for all projects
  • Simpler command invocation
Cons:
  • Version inconsistency across projects
  • Team members might use different versions
  • Not tracked in package.json
Best for: Personal projects, solo development, quick testing

​
Adding npm scripts

For local installations, add npm scripts to your package.json for convenience:
package.json
{
  "scripts": {
    "audio:generate": "speak-mintlify generate .",
    "audio:preview": "speak-mintlify generate . --dry-run",
    "audio:cleanup": "speak-mintlify cleanup ."
  }
}
Now you can run: 
npm run audio:generate
npm run audio:preview
npm run audio:cleanup
This approach makes it easy for team members to run the correct commands without remembering flags.

​
Verifying installation

Verify speak-mintlify is installed correctly: 
npx speak-mintlify --version
You should see the version number (e.g., 1.1.3).

​
Updating speak-mintlify

Keep speak-mintlify up to date to get the latest features and bug fixes: 
npm update speak-mintlify
To update to a specific version: 
npm install speak-mintlify@1.1.3

​
Uninstalling

If you need to remove speak-mintlify: 
npm uninstall speak-mintlify

​
Next steps

Now that you have speak-mintlify installed:

Quickstart

Follow the quickstart guide to generate your first audio files

Configuration

Learn how to configure voices, S3 storage, and components

Build docs developers (and LLMs) love

Get started for freeTalk to us