You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: development.mdx
+10-45Lines changed: 10 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,56 +4,29 @@ description: 'Preview changes locally to update your docs'
4
4
---
5
5
6
6
<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.
10
8
</Info>
11
9
12
10
**Step 1**: Install Mintlify:
13
11
14
-
<CodeGroup>
12
+
test
15
13
14
+
<CodeGroup>
16
15
```bash npm
17
16
npm i -g mintlify
18
17
```
19
18
20
19
```bash yarn
21
20
yarn global add mintlify
22
21
```
23
-
24
-
```bash pnpm
25
-
pnpm add -g mintlify
26
-
```
27
-
28
22
</CodeGroup>
29
23
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:
31
25
32
26
```bash
33
27
mintlify dev
34
28
```
35
29
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
-
57
30
A local preview of your documentation will be available at `http://localhost:3000`.
58
31
59
32
### Custom Ports
@@ -75,19 +48,13 @@ Port 3000 is already in use. Trying 3001 instead.
75
48
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:
76
49
77
50
<CodeGroup>
78
-
79
51
```bash npm
80
52
npm i -g mintlify@latest
81
53
```
82
54
83
55
```bash yarn
84
56
yarn global upgrade mintlify
85
57
```
86
-
87
-
```bash pnpm
88
-
pnpm up --global mintlify
89
-
```
90
-
91
58
</CodeGroup>
92
59
93
60
## Validating Links
@@ -103,10 +70,7 @@ mintlify broken-links
103
70
If the deployment is successful, you should see the following:
0 commit comments