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
+16-14Lines changed: 16 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ description: 'Preview changes locally to update your docs'
33
33
mintlify dev
34
34
```
35
35
36
-
Alternatively, if you do not want to install Mintlify globally you can use a run script available:
36
+
Alternatively, if you don't want to install Mintlify globally, you can use a run script:
37
37
38
38
<CodeGroup>
39
39
```bash npm
@@ -51,28 +51,28 @@ Alternatively, if you do not want to install Mintlify globally you can use a run
51
51
</CodeGroup>
52
52
53
53
<Warning>
54
-
Yarn's "dlx" run script requires yarn version >2. See [here](https://yarnpkg.com/cli/dlx) for more information.
54
+
Yarn's `dlx` run script requires Yarn version >2. See [here](https://yarnpkg.com/cli/dlx) for more information.
55
55
</Warning>
56
56
57
57
A local preview of your documentation will be available at `http://localhost:3000`.
58
58
59
59
### Custom Ports
60
60
61
-
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:
61
+
By default, Mintlify uses port 3000. You can customize the port Mintlify runs on by using the `--port` flag. For example, to run Mintlify on port 3333, use this command:
62
62
63
63
```bash
64
64
mintlify dev --port 3333
65
65
```
66
66
67
-
If you attempt to run Mintlify on a port that's already in use, it will use the next available port:
67
+
If you attempt to run Mintlify on a port that's already in use, it will automatically use the next available port:
68
68
69
69
```md
70
70
Port 3000 is already in use. Trying 3001 instead.
71
71
```
72
72
73
73
## Mintlify Versions
74
74
75
-
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:
75
+
Each CLI release is associated with a specific version of Mintlify. If your local website doesn't align with the production version, update the CLI:
76
76
77
77
<CodeGroup>
78
78
@@ -92,15 +92,15 @@ Please note that each CLI release is associated with a specific version of Mintl
92
92
93
93
## Validating Links
94
94
95
-
The CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command:
95
+
The Mintlify CLI can help validate reference links in your documentation. To identify any broken links, use the following command:
96
96
97
97
```bash
98
98
mintlify broken-links
99
99
```
100
100
101
101
## Deployment
102
102
103
-
If the deployment is successful, you should see the following:
103
+
After a successful deployment, you should see the following:
104
104
105
105
<Frame>
106
106
<img
@@ -111,21 +111,23 @@ If the deployment is successful, you should see the following:
111
111
112
112
## Code Formatting
113
113
114
-
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.
114
+
For optimal code formatting and syntax recognition, we recommend using extensions in your IDE. For VSCode users, we suggest:
115
+
-[MDX VSCode Extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting
116
+
-[Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting
115
117
116
118
## Troubleshooting
117
119
118
120
<AccordionGroup>
119
121
<Accordiontitle='Error: Could not load the "sharp" module using the darwin-arm64 runtime'>
120
122
121
-
This may be due to an outdated version of node. Try the following:
122
-
1. Remove the currently-installed version of mintlify: `npm remove -g mintlify`
123
-
2. Upgrade to Node v19 or higher.
124
-
3. Reinstall mintlify: `npm install -g mintlify`
123
+
This error may occur due to an outdated version of Node.js. Try the following:
124
+
1. Remove the currently-installed version of Mintlify: `npm remove -g mintlify`
125
+
2. Upgrade to Node.js v19 or higher
126
+
3. Reinstall Mintlify: `npm install -g mintlify`
125
127
</Accordion>
126
128
127
129
<Accordiontitle="Issue: Encountering an unknown error">
128
130
129
-
Solution: Go to the root of your device and delete the \~/.mintlify folder. Afterwards, run `mintlify dev` again.
131
+
Solution: Navigate to the root of your device and delete the `~/.mintlify` folder. Then, run `mintlify dev` again.
0 commit comments