| title | Development |
|---|---|
| description | Preview the OpenLegion docs site locally |
Follow these steps to install and run Mintlify on your operating system.
npm i -g mintNavigate to the docs directory where docs.json is located, and run:
mint devA local preview will be available at http://localhost:3000.
By default, Mintlify uses port 3000. Customize with the --port flag:
mint dev --port 3333Each CLI release is associated with a specific version of Mintlify. If your local preview doesn't match production, update the CLI:
mint updateIdentify any broken links:
mint broken-linksWe suggest using extensions on your IDE to recognize and format MDX. If you're a VSCode user, consider the MDX VSCode extension for syntax highlighting, and Prettier for code formatting.
This may be due to an outdated version of node. Try the following: 1. Remove the currently-installed version of the CLI: `npm remove -g mint` 2. Upgrade to Node v19 or higher. 3. Reinstall the CLI: `npm i -g mint` Solution: Go to the root of your device and delete the `~/.mintlify` folder. Then run `mint dev` again.Curious about what changed in the latest CLI version? Check out the CLI changelog.