Repository files navigation

Before you start, ensure you have the following installed:

• Git:Download Git (for version control)
• Node.js:Download Node.js (LTS version recommended)
• A GitHub account
• A code editor: e.g.,Visual Studio Code

Mintlify CLI requiresNode.js version 19 or higher.

• Check your current version:

  node -v

• If needed, install or upgrade Node.js:
  • Using Node Version Manager (nvm):

    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh| bashnvm install node

  • Direct download: Visit theofficial Node.js website and download the latest version.

Install via npm:

npm install -g mintlify

This command installs the Mintlify CLI globally, allowing you to use it from any directory.

Check the installed version:

mintlify --version

This ensures that the CLI is installed correctly and is accessible from your terminal.

1. Navigate to your project directory (ensure it contains thedocs.json file).
2. Run the development server:

   mintlify dev

3. Open your browser and visithttp://localhost:3000 to view your documentation.

If port 3000 is in use or you prefer a different port:

mintlify dev --port 3333

This starts the server on port 3333.