Local Development

Preview changes locally to update your docs

Prerequisite: Node.js (version 19 or higher)

Quick Start

1. Install Mintlify CLI:

npm

npm i -g mintlify

2. Go to your docs directory and run:

mintlify dev

Your docs will be available at http://localhost:3000

Common Tasks

Change Port

Use --port flag to run on a different port:

mintlify dev --port 3333

Update Mintlify

Keep your CLI up to date with:

npm

npm i -g mintlify@latest

Check for Broken Links

mintlify broken-links

Troubleshooting

Sharp Module Error (darwin-arm64)

1. Remove mintlify: npm remove -g mintlify
2. Upgrade to Node v19+
3. Reinstall: npm install -g mintlify

Unknown Errors

Delete ~/.mintlify folder and run mintlify dev again.