Skip to main content
This page is for anyone editing or contributing to this documentation repo (not for Flowra API users).
Prerequisites: Node.js 19+ and a clone of this repo with a docs.json file.

Preview locally

1

Install Mintlify CLI

npm i -g mint
2

Run the preview server

From the repo root (where docs.json lives):
mint dev
Open http://localhost:3000 to view the docs. The preview reloads as you edit.

Custom port

mint dev --port 3333
If the port is in use, Mintlify will try the next available port. To find broken links:
mint broken-links

Formatting

Use an MDX-capable formatter (e.g. Prettier) and, if you use VS Code, the MDX extension for syntax highlighting.