From c5eae313c7033f0e9bb2adb47acf978a5fcafbd9 Mon Sep 17 00:00:00 2001
From: Frankie <26727138+frankievalentine@users.noreply.github.com>
Date: Mon, 24 Jun 2024 20:42:12 -0700
Subject: [PATCH 1/2] Update development.mdx
---
development.mdx | 79 +++++++++++++++++++++++++++++++++++--------------
1 file changed, 57 insertions(+), 22 deletions(-)
diff --git a/development.mdx b/development.mdx
index 87830089..7cdd68ea 100644
--- a/development.mdx
+++ b/development.mdx
@@ -4,59 +4,92 @@ description: 'Learn how to preview changes locally'
---
- **Prerequisite** You should have installed Node.js (version 18.10.0 or
- higher).
+
+**Prerequisite**: Please install Node.js (version 19 or higher) before proceeding.
+
-Step 1. Install Mintlify on your OS:
+Follow these steps to install and run Mintlify on your operating system:
+
+**Step 1**: Install Mintlify:
-```bash npm
-npm i -g mintlify
-```
+ ```bash npm
+ npm i -g mintlify
+ ```
-```bash yarn
-yarn global add mintlify
-```
+ ```bash yarn
+ yarn global add mintlify
+ ```
+
+ ```bash pnpm
+ pnpm add -g mintlify
+ ```
-Step 2. Go to the docs are located (where you can find `mint.json`) and run the following command:
+**Step 2**: Navigate to the docs directory (where the `mint.json` file is located) and execute the following command:
```bash
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.
+
+
The documentation website is now available at `http://localhost:3000`.
### Custom Ports
-Mintlify uses port 3000 by default. You can use the `--port` flag to customize the port Mintlify runs on. For example, use this command to run in port 3333:
+By default, Mintlify uses port 3000. You can customize the port Mintlify runs on by using the `--port` flag. To run Mintlify on port 3333, for instance, use this command:
```bash
mintlify dev --port 3333
```
-You will see an error like this if you try to run Mintlify in a port that's already taken:
+If you attempt to run Mintlify on a port that's already in use, it will use the next available port:
```md
-Error: listen EADDRINUSE: address already in use :::3000
+Port 3000 is already in use. Trying 3001 instead.
```
## Mintlify Versions
-Each CLI is linked to a specific version of Mintlify. Please update the CLI if your local website looks different than production.
+Please note that each CLI release is associated with a specific version of Mintlify. If your local website doesn't align with the production version, please update the CLI:
-```bash npm
-npm i -g mintlify@latest
-```
+ ```bash npm
+ npm i -g mintlify@latest
+ ```
-```bash yarn
-yarn global upgrade mintlify
-```
+ ```bash yarn
+ yarn global upgrade mintlify
+ ```
+
+ ```bash pnpm
+ pnpm up --global
+ ```
@@ -73,9 +106,11 @@ You should see the following if the deploy successfully went through:
-## Troubleshooting
+## Code Formatting
-Here's how to solve some common problems when working with the CLI.
+We suggest using extensions on your IDE to recognize and format MDX. If you're a VSCode user, consider the [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting.
+
+## Troubleshooting
From 008a9b6b857f50491aa5eeb167ce0e165ddec2d1 Mon Sep 17 00:00:00 2001
From: Frankie <26727138+frankievalentine@users.noreply.github.com>
Date: Mon, 24 Jun 2024 20:49:06 -0700
Subject: [PATCH 2/2] Update README.md
---
README.md | 27 ++++++++++++++++++++++++++-
1 file changed, 26 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 4cbe0750..0228d040 100644
--- a/README.md
+++ b/README.md
@@ -16,15 +16,40 @@ Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview th
npm i -g mintlify
```
+```
+yarn global add mintlify
+```
+
+```
+pnpm add -g mintlify
+```
+
Run the following command at the root of your documentation (where mint.json is)
```
mintlify dev
```
+Alternatively, you can use a run script if you don't want to install Mintlify globally.
+
+```
+npx mintlify dev
+```
+
+```
+yarn dlx mintlify dev
+```
+
+```
+pnpm dlx mintlify dev
+```
+
+Note:
+> _Yarn's "dlx" run script requires yarn version >2. See [here](https://yarnpkg.com/cli/dlx) for more information._
+
### Publishing Changes
-Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.
+Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.
#### Troubleshooting