Skip to main content

​
Get started in 3 steps

Preview locally and apply your first changes.

​
Step 1: Prepare local environment

  1. Install Mintlify CLI: npm i -g mint
  2. Preview in document directory: mint dev
  3. Open http://localhost:3000
The live preview will update automatically as you edit.

​
Step 2: Change site settings

Adjust the appearance by updating name and colors in docs.json.

​
Step 3: Publish

Once you commit and push your changes, the deployment will run and update your site.