Skip to content

README.md

Latest commit

 

History

History
52 lines (34 loc) · 1 KB

README.md

File metadata and controls

52 lines (34 loc) · 1 KB
Raw

Getting Started with Mintlify

Prerequisites

Before you begin, make sure you have Node.js 20–24 installed (Mintlify does not support Node 25+).

Install Node.js (includes npm)

macOS (via Homebrew):

brew install node@22

Windows (via winget):

winget install OpenJS.NodeJS.LTS

After installing, verify with:

node -v
npm -v

Install and Use Mintlify Locally

1. Install the Mintlify CLI:

npm i -g mint

2. Navigate to the docs directory (where docs.json is located) and start the local preview:

mint dev

Alternatively, without installing the CLI globally :

npx mint dev

A local preview of your documentation will be available at http://localhost:3000. Please note that the rendering behavior in the local preview may differ from the deployed version. The deployed result should be considered as the final reference.