Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 35 additions & 6 deletions development.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,13 @@ Follow these steps to install and run Mintlify on your operating system:
npm i -g mintlify
```

```bash yarn
yarn global add mintlify
```
```bash yarn
yarn global add mintlify
```

```bash pnpm
pnpm add -g mintlify
```

</CodeGroup>

Expand All @@ -30,6 +34,27 @@ yarn global add mintlify
mintlify dev
```

Alternatively, if you do not want to install Mintlify globally you can use a run script available:

<CodeGroup>
```bash npm
npx mintlify dev
```

```bash yarn
yarn dlx mintlify dev
```

```bash pnpm
pnpm dlx mintlify dev
```

</CodeGroup>

<Warning>
Yarn's "dlx" run script requires yarn version >2. See [here](https://yarnpkg.com/cli/dlx) for more information.
</Warning>

A local preview of your documentation will be available at `http://localhost:3000`.

### Custom Ports
Expand All @@ -55,9 +80,13 @@ Please note that each CLI release is associated with a specific version of Mintl
npm i -g mintlify@latest
```

```bash yarn
yarn global upgrade mintlify
```
```bash yarn
yarn global upgrade mintlify
```

```bash pnpm
pnpm up --global mintlify
```

</CodeGroup>

Expand Down