Skip to main content
Prerequisites:

Run the docs locally

1

Clone the repository

git clone https://github.com/ernestova/docs.clarivo.co.git
cd docs.clarivo.co
2

Install the Mintlify CLI

npm i -g mint
3

Start the preview server

mint dev
A local preview will be available at http://localhost:3000.
The preview updates automatically as you edit files — no need to restart.

Custom ports

By default the preview runs on port 3000. Use --port to change it:
mint dev --port 3333
If port 3000 is already in use, the CLI picks the next available port automatically:
Port 3000 is already in use. Trying 3001 instead.
Before opening a PR, check for broken links:
mint broken-links

Deployment

Changes merged to main are deployed automatically. A successful deployment shows:
All checks have passed.

Code formatting

For VSCode users, install:

Troubleshooting

This is usually caused by an outdated Node version:
  1. Remove the CLI: npm remove -g mint
  2. Upgrade to Node v19 or higher
  3. Reinstall: npm i -g mint
Delete the local Mintlify cache and restart:
rm -rf ~/.mintlify
mint dev