Skip to content

development.mdx

Latest commit

 

History

History
49 lines (40 loc) · 1.22 KB

development.mdx

File metadata and controls

49 lines (40 loc) · 1.22 KB
title Development
description Install the Mintlify CLI to preview changes locally
Using the [npm](https://www.npmjs.com) package manager 
npm i -g mintlify
Using the [yarn](https://yarnpkg.com) package manager 
yarn global add mintlify

Previewing Changes Locally

Run the following command at the root of your documentation where mint.json is located. Mintlify will open at localhost:3000.

mintlify dev

Troubleshooting

Here's how to solve some common problems when working with the CLI.

Update to Node v18 and the latest version of Git. Run `mintlify install` and try again. The Mintlify CLI will automatically move to the next port if you were already running something at `localhost:3000`. For example, if you were running two documentation sites, they would be at `localhost:3000` and `localhost:3001`.