Run these docs locally to preview changes before you publish them. Edits to .mdx files and docs.json reload in the browser as you save.

​
Prerequisites

  • Node.js version 19 or higher, up to the current LTS. Mintlify does not support Node 25 or later, so use an LTS release such as Node 22.
  • The Mintlify CLI installed globally.
Check your version with node --version. If you run a newer release, use a version manager such as nvm to switch to Node 22.

​
Install the CLI

​
Preview locally

Run the dev server from the directory that contains docs.json:
The preview is available at http://localhost:3000. To use a different port:

​
Validate before publishing

1

Check for broken links

2

Check accessibility

​
Troubleshooting

Mintlify does not run on Node 25 or later. Switch to an LTS release:
Reinstall the CLI to get the latest version, then restart the dev server: