Skip to content

Commit 25bbaac

Browse files
Add pnpm install and run scripts to Development doc (#199)
* Update development.mdx Add pnpm install instructions to the development documentation. As well as alternative instructions for using run scripts instead of installing the Mintlify package globally. * specify mintlify in pnpm up --------- Co-authored-by: Ronan McCarter <[email protected]>
1 parent d06a07a commit 25bbaac

File tree

1 file changed

+35
-6
lines changed

1 file changed

+35
-6
lines changed

development.mdx

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,13 @@ description: 'Preview changes locally to update your docs'
1717
npm i -g mintlify
1818
```
1919

20-
```bash yarn
21-
yarn global add mintlify
22-
```
20+
```bash yarn
21+
yarn global add mintlify
22+
```
23+
24+
```bash pnpm
25+
pnpm add -g mintlify
26+
```
2327

2428
</CodeGroup>
2529

@@ -29,6 +33,27 @@ yarn global add mintlify
2933
mintlify dev
3034
```
3135

36+
Alternatively, if you do not want to install Mintlify globally you can use a run script available:
37+
38+
<CodeGroup>
39+
```bash npm
40+
npx mintlify dev
41+
```
42+
43+
```bash yarn
44+
yarn dlx mintlify dev
45+
```
46+
47+
```bash pnpm
48+
pnpm dlx mintlify dev
49+
```
50+
51+
</CodeGroup>
52+
53+
<Warning>
54+
Yarn's "dlx" run script requires yarn version >2. See [here](https://yarnpkg.com/cli/dlx) for more information.
55+
</Warning>
56+
3257
A local preview of your documentation will be available at `http://localhost:3000`.
3358

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

58-
```bash yarn
59-
yarn global upgrade mintlify
60-
```
83+
```bash yarn
84+
yarn global upgrade mintlify
85+
```
86+
87+
```bash pnpm
88+
pnpm up --global mintlify
89+
```
6190

6291
</CodeGroup>
6392

0 commit comments

Comments
 (0)