Skip to content
Merged
Show file tree
Hide file tree
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
24 changes: 19 additions & 5 deletions installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,16 @@ icon: "terminal"
<Step title="Install the CLI.">
Run the following command to install the [CLI](https://www.npmjs.com/package/mint):

```bash
<CodeGroup>
```bash npm
npm i -g mint
```

```bash pnpm
pnpm add -g mint
```
</CodeGroup>

</Step>
<Step title="Preview locally.">
Navigate to your docs directory (where your `docs.json` file is located) and execute the following command:
Expand Down Expand Up @@ -56,9 +62,15 @@ mint update

If this `mint update` command is not available on your local version, re-install the CLI with the latest version:

```bash
npm i -g mint@latest
```
<CodeGroup>
```bash npm
npm i -g mint@latest
```

```bash pnpm
pnpm add -g mint@latest
```
</CodeGroup>

## Custom ports

Expand Down Expand Up @@ -137,6 +149,8 @@ If you use JetBrains, we recommend the [MDX IntelliJ IDEA plugin](https://plugin
</Accordion>
<Accordion title="mintlify vs. mint package">
If you have any problems with the CLI package, you should first run `npm ls -g`. This command shows what packages are globally installed on your machine.

If you don't use npm or don't see it in the -g list, try `which mint` to locate the installation.

If you have a package named `mint` and a package named `mintlify` installed, you should uninstall `mintlify`.

Expand All @@ -150,7 +164,7 @@ If you use JetBrains, we recommend the [MDX IntelliJ IDEA plugin](https://plugin
```
3. Reinstall the new package:
```bash
npm install -g mint
npm i -g mint
```
</Accordion>
</AccordionGroup>
12 changes: 9 additions & 3 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,15 @@ The code-based workflow integrates with your existing development environment an

To work locally with your documentation, install the Command Line Interface (CLI), called [mint](https://www.npmjs.com/package/mint), by running this command in your terminal:

```bash
npm i -g mint
```
<CodeGroup>
```bash npm
npm i -g mint
```

```bash pnpm
pnpm add -g mint
```
</CodeGroup>

<Info>
You need Node.js installed on your machine. If you encounter installation issues, check the troubleshooting guide.
Expand Down