Local Development

Preview changes locally to update your docs

Prerequisite: Node.js (version 19 or higher)

Quick Setup

1. Install Mintlify:

2. Run the dev server:

mintlify dev

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

Common Commands

# Run on custom port
mintlify dev --port <port>

# Check for broken links
mintlify broken-links

# Update CLI
npm i -g mintlify@latest # or yarn global upgrade mintlify

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.

Development Tools

• MDX VSCode extension - Syntax highlighting
• Prettier - Code formatting