mintlify 4.0.582 → 4.0.584
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -7
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -49,7 +49,7 @@ Run this command at the root of your Mintlify project to preview changes locally
|
|
|
49
49
|
|
|
50
50
|
Notes
|
|
51
51
|
|
|
52
|
-
- `mintlify dev` requires Node
|
|
52
|
+
- `mintlify dev` requires Node v19 or higher.
|
|
53
53
|
|
|
54
54
|
#### Custom Ports
|
|
55
55
|
|
|
@@ -70,16 +70,12 @@ Error: listen EADDRINUSE: address already in use :::3000
|
|
|
70
70
|
Steps you can take if the dev CLI is not working (After each step try to run `mintlify dev` again):
|
|
71
71
|
|
|
72
72
|
- Make sure you are running in a folder with a `docs.json` file.
|
|
73
|
-
- Run `
|
|
74
|
-
- Make sure you are using Node
|
|
73
|
+
- Run `mintlify update` to ensure you have the most recent version of the CLI.
|
|
74
|
+
- Make sure you are using Node v19 or higher.
|
|
75
75
|
- Navigate to the `.mintlify` folder in your home directory and delete its contents.
|
|
76
76
|
|
|
77
77
|
### Additional Commands
|
|
78
78
|
|
|
79
|
-
#### `mintlify openapi-check <openapiFilenameOrUrl>`
|
|
80
|
-
|
|
81
|
-
Check your OpenAPI file for errors. You can pass in a filename (e.g. `./openapi.yaml`) or a URL (e.g. `https://petstore3.swagger.io/api/v3/openapi.json`).
|
|
82
|
-
|
|
83
79
|
#### `mintlify broken-links`
|
|
84
80
|
|
|
85
81
|
Check for broken internal links in your Mintlify project.
|
|
@@ -88,6 +84,18 @@ Check for broken internal links in your Mintlify project.
|
|
|
88
84
|
|
|
89
85
|
Rename a file in a Mintlify project and update all internal link references.
|
|
90
86
|
|
|
87
|
+
#### `mintlify openapi-check <openapiFilenameOrUrl>`
|
|
88
|
+
|
|
89
|
+
Check your OpenAPI file for errors. You can pass in a filename (e.g. `./openapi.yaml`) or a URL (e.g. `https://petstore3.swagger.io/api/v3/openapi.json`).
|
|
90
|
+
|
|
91
|
+
#### `mintlify update`
|
|
92
|
+
|
|
93
|
+
Updates to the most recent version of the Mintlify CLI.
|
|
94
|
+
|
|
95
|
+
#### `mintlify upgrade`
|
|
96
|
+
|
|
97
|
+
Upgrade from `mint.json` to `docs.json`. This command creates a `docs.json` from your existing `mint.json`.
|
|
98
|
+
|
|
91
99
|
### Get Started
|
|
92
100
|
|
|
93
101
|
[Create an account](https://mintlify.com/start) to start using Mintlify for your documentation.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mintlify",
|
|
3
|
-
"version": "4.0.
|
|
3
|
+
"version": "4.0.584",
|
|
4
4
|
"description": "The Mintlify CLI",
|
|
5
5
|
"engines": {
|
|
6
6
|
"node": ">=18.0.0"
|
|
@@ -28,10 +28,10 @@
|
|
|
28
28
|
"clean:all": "rimraf node_modules"
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@mintlify/cli": "4.0.
|
|
31
|
+
"@mintlify/cli": "4.0.582"
|
|
32
32
|
},
|
|
33
33
|
"devDependencies": {
|
|
34
34
|
"rimraf": "^5.0.1"
|
|
35
35
|
},
|
|
36
|
-
"gitHead": "
|
|
36
|
+
"gitHead": "7bf669f140025f875ec3c198fb815688a085575f"
|
|
37
37
|
}
|