Development

Preview changes locally to update your docs

Prerequisite: Please install Node.js (version 19 or higher) before proceeding.Follow these steps to install and run Mintlify on your operating system:Step 1: Install Mintlify:npmyarn

Step 2: Navigate to the docs directory (where the docs.json file is located) and execute the following command:

A local preview of your documentation will be available at http://localhost:3000.

Custom Ports

By default, Mintlify uses port 3000. You can customize the port Mintlify runs on by using the --port flag. To run Mintlify on port 3333, for instance, use this command:

If you attempt to run Mintlify on a port that’s already in use, it will use the next available port:

Mintlify Versions

Please note that each CLI release is associated with a specific version of Mintlify. If your local website doesn’t align with the production version, please update the CLI:npmyarn

Validating Links

The CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command:

Deployment

Unlimited editors available under the Pro Plan and above.If the deployment is successful, you should see the following:

Code Formatting

We suggest using extensions on your IDE to recognize and format MDX. If you’re a VSCode user, consider the MDX VSCode extension for syntax highlighting, and Prettier for code formatting.

Troubleshooting

Error: Could not load the "sharp" module using the darwin-arm64 runtime

1.

2.

3.

Issue: Encountering an unknown error

QuickstartMarkdown Syntaxx github linkedin Powered by

January 22, 2026