Prerequisite: You should have installed Node.js
(version 20 or higher) and cloned the NCTHub
Monorepo to your local machine.
Step 1. Install Mintlify on your local machine:
Step 2. Go to the docs are located (navigate to apps/docs) and run the following command:
The documentation website is now available at http://localhost:3000.
Use cd apps/docs to navigate to the docs folder.
Custom Ports
Mintlify uses port 3000 by default. You can use the --port flag to customize the port Mintlify runs on. For example, use this command to run in port 3333:
You will see an error like this if you try to run Mintlify in a port that’s already taken:
Error: listen EADDRINUSE: address already in use :::3000
Mintlify Versions
Each CLI is linked to a specific version of Mintlify. Please update the CLI if your local website looks different than production.