Prerequisites

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

Setting Up Your Local Environment

🛠️ Installing the Mintlify CLI

Step 1: Ensure Node.js is Installed

Mintlify CLI requires Node.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 | bash
    nvm install node

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

Step 2: Install the Mintlify CLI Globally

Install via npm:

npm install -g mintlify

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

Step 3: Verify the Installation

Check the installed version:

mintlify --version

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

🚀 Using the Mintlify CLI in Your Workflow

Preview Documentation Locally

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

   mintlify dev

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

Customize the Development Server Port

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

mintlify dev --port 3333

This starts the server on port 3333.