Zum Hauptinhalt springen
Prerequisite You should have installed Node.js (version 20.17.0 or higher).
Step 1. Install the Mint CLI: 
npm i -g mint
Step 2. Go to the root of your docs app (where docs.json lives) and run: 
mint dev
The documentation website is now available at http://localhost:3000.

​
Custom Ports

Mint uses port 3000 by default. You can use the --port flag to customize the port. For example, use this command to run on port 3333: 
mint dev --port 3333
If the port is already taken, Mint falls back to the next available port: 
Port 3000 is already in use. Trying 3001 instead.
If you do not want to install the CLI globally, you can also run: 
npx mint dev

​
CLI Versions

Each CLI is linked to a specific version of Mintlify. Please update the CLI if your local website looks different than production. 
mint update

​
Deployment

Unlimited editors available under the Startup Plan
You should see the following if the deploy successfully went through:

​
Troubleshooting

Here’s how to solve some common problems when working with the CLI.
Verify that you are on Node.js v20.17.0 or newer. Then run mint update and try mint dev again.
Try navigating to the root of your device and delete the ~/.mintlify folder. Then run mint dev again.
Curious about what changed recently? Check the Mintlify product updates.