Skip to content

Commit 14b4c6c

Browse files
lawrekaethanpalm
andauthored
Add pnpm back to CLI docs (#939)
* add code group with pnpm back * add pnpm add commands --------- Co-authored-by: Ethan Palm <[email protected]>
1 parent 6dbe1d1 commit 14b4c6c

File tree

2 files changed

+28
-8
lines changed

2 files changed

+28
-8
lines changed

installation.mdx

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,16 @@ icon: "terminal"
2424
<Step title="Install the CLI.">
2525
Run the following command to install the [CLI](https://www.npmjs.com/package/mint):
2626

27-
```bash
27+
<CodeGroup>
28+
```bash npm
2829
npm i -g mint
2930
```
3031

32+
```bash pnpm
33+
pnpm add -g mint
34+
```
35+
</CodeGroup>
36+
3137
</Step>
3238
<Step title="Preview locally.">
3339
Navigate to your docs directory (where your `docs.json` file is located) and execute the following command:
@@ -56,9 +62,15 @@ mint update
5662

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

59-
```bash
60-
npm i -g mint@latest
61-
```
65+
<CodeGroup>
66+
```bash npm
67+
npm i -g mint@latest
68+
```
69+
70+
```bash pnpm
71+
pnpm add -g mint@latest
72+
```
73+
</CodeGroup>
6274

6375
## Custom ports
6476

@@ -137,6 +149,8 @@ If you use JetBrains, we recommend the [MDX IntelliJ IDEA plugin](https://plugin
137149
</Accordion>
138150
<Accordion title="mintlify vs. mint package">
139151
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.
152+
153+
If you don't use npm or don't see it in the -g list, try `which mint` to locate the installation.
140154

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

@@ -150,7 +164,7 @@ If you use JetBrains, we recommend the [MDX IntelliJ IDEA plugin](https://plugin
150164
```
151165
3. Reinstall the new package:
152166
```bash
153-
npm install -g mint
167+
npm i -g mint
154168
```
155169
</Accordion>
156170
</AccordionGroup>

quickstart.mdx

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,15 @@ The code-based workflow integrates with your existing development environment an
8282

8383
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:
8484

85-
```bash
86-
npm i -g mint
87-
```
85+
<CodeGroup>
86+
```bash npm
87+
npm i -g mint
88+
```
89+
90+
```bash pnpm
91+
pnpm add -g mint
92+
```
93+
</CodeGroup>
8894

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

0 commit comments

Comments
 (0)