Skip to content

Commit 8545a2a

Browse files
committed
update cli docs
1 parent f9f11f6 commit 8545a2a

File tree

1 file changed

+24
-29
lines changed

1 file changed

+24
-29
lines changed

installation.mdx

Lines changed: 24 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,6 @@ icon: "terminal"
2929
npm i -g mint
3030
```
3131

32-
33-
```bash yarn
34-
yarn global add mint
35-
```
36-
37-
38-
```bash pnpm
39-
pnpm add -g mint
40-
```
41-
4232
</CodeGroup>
4333
</Step>
4434
<Step title="Preview locally.">
@@ -61,15 +51,6 @@ npx mint dev
6151
```
6252

6353

64-
```bash yarn
65-
yarn dlx mint dev
66-
```
67-
68-
69-
```bash pnpm
70-
pnpm dlx mint dev
71-
```
72-
7354
</CodeGroup>
7455

7556
## Updates
@@ -89,15 +70,6 @@ npm i -g mint@latest
8970
```
9071

9172

92-
```bash yarn
93-
yarn global upgrade mint
94-
```
95-
96-
97-
```bash pnpm
98-
pnpm up --global mint
99-
```
100-
10173
</CodeGroup>
10274

10375
## Custom ports
@@ -158,11 +130,34 @@ If you use JetBrains, we recommend the [MDX IntelliJ IDEA plugin](https://plugin
158130
<Accordion title='Error: Could not load the "sharp" module using the darwin-arm64 runtime'>
159131
This may be due to an outdated version of node. Try the following:
160132

161-
1. Remove the currently-installed version of the mint CLI: `npm remove -g mint`
133+
1. Remove the currently-installed version of the mint CLI: `npm uninstall -g mint`
162134
2. Upgrade to Node.js.
163135
3. Reinstall the mint CLI: `npm install -g mint`
164136
</Accordion>
165137
<Accordion title="Issue: Encountering an unknown error">
166138
Solution: Go to the root of your device and delete the `~/.mintlify` folder. Afterwards, run `mint dev` again.
167139
</Accordion>
140+
<Accordion title="Error: permission denied">
141+
This is due to not having the required permissions to globally install node packages.
142+
Solution: Try running `sudo npm i -g mint`. You will be prompted for your password, which is the one you use to unlock your computer.
143+
</Accordion>
144+
<Accordion title="The local preview doesn't look the same as my docs do on the web">
145+
Likely this is due to an outdated version of the CLI.
146+
Solution: Run `mint update` to get the latest changes.
147+
</Accordion>
148+
<Accordion title="mintlify vs. mint package">
149+
When having any problems with the CLI package, the first thing we'll ask you to do when troubleshooting is paste the output of `npm ls -g`, which shows what packages are globally installed on your machine. You may see that you have a package named "mint" and a package named "mintlify" installed. It will be less confusing to have only one of them installed.
150+
1. Uninstall the old package:
151+
```bash
152+
npm uninstall -g mintlify
153+
```
154+
2. Clear your npm cache:
155+
```bash
156+
npm cache clean --force
157+
```
158+
3. Reinstall the new package:
159+
```bash
160+
npm install -g mint
161+
```
162+
</Accordion>
168163
</AccordionGroup>

0 commit comments

Comments
 (0)