Skip to content

Latest commit

 

History

History
77 lines (54 loc) · 1.99 KB

File metadata and controls

77 lines (54 loc) · 1.99 KB
title Development
description Preview the OpenLegion docs site locally
**Prerequisites**: - Node.js version 19 or higher - This docs repository with its `docs.json` file

Follow these steps to install and run Mintlify on your operating system.

npm i -g mint

Navigate to the docs directory where docs.json is located, and run:

mint dev

A local preview will be available at http://localhost:3000.

Custom ports

By default, Mintlify uses port 3000. Customize with the --port flag:

mint dev --port 3333

Mintlify versions

Each CLI release is associated with a specific version of Mintlify. If your local preview doesn't match production, update the CLI:

mint update

Validating links

Identify any broken links:

mint broken-links

Code formatting

We 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.

Troubleshooting

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.