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: installation.mdx
+46-29Lines changed: 46 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ icon: "terminal"
5
5
---
6
6
7
7
<Info>
8
-
**Prerequisite**: Please install Node.js (version 19 or higher) before proceeding.
8
+
**Prerequisite**: Please install [Node.js](https://nodejs.org/en) (version 19 or higher) before proceeding.
9
9
</Info>
10
10
11
11
**Step 1**: Install the Mintlify CLI:
@@ -34,7 +34,7 @@ pnpm add -g mintlify
34
34
mintlify dev
35
35
```
36
36
37
-
Alternatively, if you do not want to install the CLI globally you can use a run script available:
37
+
Alternatively, if you do not want to install the CLI globally, you can use a run a one-time script:
38
38
39
39
<CodeGroup>
40
40
@@ -56,23 +56,9 @@ pnpm dlx mintlify dev
56
56
57
57
A local preview of your documentation will be available at `http://localhost:3000`.
58
58
59
-
### Custom Ports
59
+
##Updates
60
60
61
-
By default, Mintlify uses port 3000. You can customize the port using the `--port` flag. To run Mintlify on port 3333, for instance, use this command:
62
-
63
-
```bash
64
-
mintlify dev --port 3333
65
-
```
66
-
67
-
If you attempt to run on a port that's already in use, it will use the next available port:
68
-
69
-
```md
70
-
Port 3000 is already in use. Trying 3001 instead.
71
-
```
72
-
73
-
## Versions
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:
61
+
Each CLI release is associated with a specific version of Mintlify. If your local preview doesn't align with the production version, please update the CLI:
76
62
77
63
<CodeGroup>
78
64
@@ -92,28 +78,59 @@ pnpm up --global mintlify
92
78
93
79
</CodeGroup>
94
80
95
-
## Validating Links
81
+
## Custom Ports
82
+
83
+
By default, the CLI uses port 3000. You can customize the port using the `--port` flag. To run the CLI on port 3333, for instance, use this command:
84
+
85
+
```bash
86
+
mintlify dev --port 3333
87
+
```
88
+
89
+
If you attempt to run on a port that's already in use, it will use the next available port:
90
+
91
+
```md
92
+
Port 3000 is already in use. Trying 3001 instead.
93
+
```
94
+
95
+
## Additional Commands
96
+
97
+
While `mintlify dev` is the most commonly used command, there are other commands you can use to manage your documentation.
98
+
99
+
### Find Broken Links
96
100
97
101
The CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command:
98
102
99
103
```bash
100
104
mintlify broken-links
101
105
```
102
106
103
-
## Deployment
107
+
### Check OpenAPI Spec
108
+
109
+
You can use the CLI to check your OpenAPI file for errors using the following command:
110
+
111
+
```bash
112
+
mintlify openapi-check <openapiFilenameOrUrl>
113
+
```
114
+
115
+
You can pass in a filename (e.g. `./openapi.yaml`) or a URL (e.g. `https://petstore3.swagger.io/api/v3/openapi.json`).
116
+
117
+
### Rename Files
118
+
119
+
You can rename files using the following command:
120
+
121
+
```bash
122
+
mintlify rename <oldFilename><newFilename>
123
+
```
124
+
125
+
This is an improvement over updating the filename normally as it will also update all references to the file, ensuring no broken links.
104
126
105
-
If the deployment is successful, you should see the following:
While developing locally, we recommend using extensions on your IDE to recognize and format MDX.
113
130
114
-
## Code Formatting
131
+
If you use Cursor, Windsurf, or VSCode, we recommend 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.
115
132
116
-
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.
133
+
If you use JetBrains, we recommend the [MDX IntelliJ IDEA plugin](https://plugins.jetbrains.com/plugin/14944-mdx) for syntax highlighting, and setting up [Prettier](https://prettier.io/docs/webstorm) for code formatting.
0 commit comments