Skip to content

Commit c648999

Browse files
Documentation edits made through Mintlify web editor
1 parent 9f9e9aa commit c648999

File tree

10 files changed

+361
-998
lines changed

10 files changed

+361
-998
lines changed

development.mdx

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ description: 'Preview changes locally to update your docs'
3333
mintlify dev
3434
```
3535

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:
3737

3838
<CodeGroup>
3939
```bash npm
@@ -51,28 +51,28 @@ Alternatively, if you do not want to install Mintlify globally you can use a run
5151
</CodeGroup>
5252

5353
<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.
5555
</Warning>
5656

5757
A local preview of your documentation will be available at `http://localhost:3000`.
5858

5959
### Custom Ports
6060

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:
6262

6363
```bash
6464
mintlify dev --port 3333
6565
```
6666

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:
6868

6969
```md
7070
Port 3000 is already in use. Trying 3001 instead.
7171
```
7272

7373
## Mintlify Versions
7474

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:
7676

7777
<CodeGroup>
7878

@@ -92,15 +92,15 @@ Please note that each CLI release is associated with a specific version of Mintl
9292

9393
## Validating Links
9494

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:
9696

9797
```bash
9898
mintlify broken-links
9999
```
100100

101101
## Deployment
102102

103-
If the deployment is successful, you should see the following:
103+
After a successful deployment, you should see the following:
104104

105105
<Frame>
106106
<img
@@ -111,21 +111,23 @@ If the deployment is successful, you should see the following:
111111

112112
## Code Formatting
113113

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
115117

116118
## Troubleshooting
117119

118120
<AccordionGroup>
119121
<Accordion title='Error: Could not load the "sharp" module using the darwin-arm64 runtime'>
120122

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`
125127
</Accordion>
126128

127129
<Accordion title="Issue: Encountering an unknown error">
128130

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.
130132
</Accordion>
131-
</AccordionGroup>
133+
</AccordionGroup>

0 commit comments

Comments
 (0)