From ed31e19c8511463d19dfdf3762bbb4a2ccef533e Mon Sep 17 00:00:00 2001
From: Frankie <26727138+frankievalentine@users.noreply.github.com>
Date: Mon, 24 Jun 2024 17:50:08 -0700
Subject: [PATCH 1/2] 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.
---
development.mdx | 41 +++++++++++++++++++++++++++++++++++------
1 file changed, 35 insertions(+), 6 deletions(-)
diff --git a/development.mdx b/development.mdx
index 0d6645880..0d90e411a 100644
--- a/development.mdx
+++ b/development.mdx
@@ -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
+ ```
@@ -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:
+
+
+ ```bash npm
+ npx mintlify dev
+ ```
+
+ ```bash yarn
+ yarn dlx mintlify dev
+ ```
+
+ ```bash pnpm
+ pnpm dlx mintlify dev
+ ```
+
+
+
+
+ Yarn's "dlx" run script requires yarn version >2. See [here](https://yarnpkg.com/cli/dlx) for more information.
+
+
A local preview of your documentation will be available at `http://localhost:3000`.
### Custom Ports
@@ -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
+ ```
From f44fb386cdd0ebf7c8adc888330bf78428265505 Mon Sep 17 00:00:00 2001
From: Ronan McCarter <63772591+rpmccarter@users.noreply.github.com>
Date: Thu, 19 Dec 2024 11:48:21 -0800
Subject: [PATCH 2/2] specify mintlify in pnpm up
---
development.mdx | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/development.mdx b/development.mdx
index 0d90e411a..2e4eb7947 100644
--- a/development.mdx
+++ b/development.mdx
@@ -85,7 +85,7 @@ Please note that each CLI release is associated with a specific version of Mintl
```
```bash pnpm
- pnpm up --global
+ pnpm up --global mintlify
```