Prerequisites:
- Node.js version 19 or higher
- This repository cloned locally
1
Install the Mintlify CLI
2
Preview locally
Navigate to this repo’s root directory and run:A local preview will be available at
http://localhost:3000.Custom ports
Validating links
Updating the CLI
OpenAPI spec
Theapi-reference/openapi.json file is auto-synced from the Yoshi API via CI after each deploy. To update it manually:
Troubleshooting
Error: Could not load the "sharp" module
Error: Could not load the "sharp" module
- Remove the CLI:
npm remove -g mint - Upgrade to Node v19 or higher
- Reinstall:
npm i -g mint
Unknown error on mint dev
Unknown error on mint dev
Delete
~/.mintlify and run mint dev again.