Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command
pnpm add -g mintlify
Run the following command at the root of your documentation (where docs.json is)
mintlify dev
Create a pull request with your changes. A preview will be automatically generated for you. Once the changes are approved, they will be merged into the main branch and released to production.
- Mintlify dev isn't running - Run
mintlify install
it'll re-install dependencies. - Page loads as a 404 - Make sure you are running in a folder with
docs.json