Skip to content

Commit 4b26a4e

Browse files
Documentation edits made through Mintlify web editor
1 parent 9868619 commit 4b26a4e

File tree

1 file changed

+10
-45
lines changed

1 file changed

+10
-45
lines changed

development.mdx

Lines changed: 10 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -4,56 +4,29 @@ description: 'Preview changes locally to update your docs'
44
---
55

66
<Info>
7-
8-
**Prerequisite**: Please install Node.js (version 19 or higher) before proceeding.
9-
7+
**Prerequisite**: Please install Node.js (version 19 or higher) before proceeding.
108
</Info>
119

1210
**Step 1**: Install Mintlify:
1311

14-
<CodeGroup>
12+
test
1513

14+
<CodeGroup>
1615
```bash npm
1716
npm i -g mintlify
1817
```
1918

2019
```bash yarn
2120
yarn global add mintlify
2221
```
23-
24-
```bash pnpm
25-
pnpm add -g mintlify
26-
```
27-
2822
</CodeGroup>
2923

30-
**Step 2**: Navigate to the docs directory (where the `docs.json` file is located) and execute the following command:
24+
**Step 2**: Navigate to the docs directory (where the `mint.json` file is located) and execute the following command:
3125

3226
```bash
3327
mintlify dev
3428
```
3529

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-
5730
A local preview of your documentation will be available at `http://localhost:3000`.
5831

5932
### Custom Ports
@@ -75,19 +48,13 @@ Port 3000 is already in use. Trying 3001 instead.
7548
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:
7649

7750
<CodeGroup>
78-
7951
```bash npm
8052
npm i -g mintlify@latest
8153
```
8254

8355
```bash yarn
8456
yarn global upgrade mintlify
8557
```
86-
87-
```bash pnpm
88-
pnpm up --global mintlify
89-
```
90-
9158
</CodeGroup>
9259

9360
## Validating Links
@@ -103,10 +70,7 @@ mintlify broken-links
10370
If the deployment is successful, you should see the following:
10471

10572
<Frame>
106-
<img
107-
className="rounded-md"
108-
src="https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/checks-passed.png"
109-
/>
73+
<img className="rounded-md" src="https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/checks-passed.png" />
11074
</Frame>
11175

11276
## Code Formatting
@@ -116,16 +80,17 @@ We suggest using extensions on your IDE to recognize and format MDX. If you're a
11680
## Troubleshooting
11781

11882
<AccordionGroup>
119-
<Accordion title='Error: Could not load the "sharp" module using the darwin-arm64 runtime'>
120-
83+
<Accordion title="Error: Could not load the &#x22;sharp&#x22; module using the darwin-arm64 runtime">
12184
This may be due to an outdated version of node. Try the following:
85+
12286
1. Remove the currently-installed version of mintlify: `npm remove -g mintlify`
87+
12388
2. Upgrade to Node v19 or higher.
89+
12490
3. Reinstall mintlify: `npm install -g mintlify`
12591
</Accordion>
12692

12793
<Accordion title="Issue: Encountering an unknown error">
128-
12994
Solution: Go to the root of your device and delete the \~/.mintlify folder. Afterwards, run `mintlify dev` again.
13095
</Accordion>
131-
</AccordionGroup>
96+
</AccordionGroup>

0 commit comments

Comments
 (0)