mintlify 3.0.67 → 3.0.68
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 +11 -6
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -43,18 +43,15 @@ npm i -g mintlify
|
|
|
43
43
|
|
|
44
44
|
### 👩💻 Development
|
|
45
45
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
```
|
|
49
|
-
mintlify dev
|
|
50
|
-
```
|
|
46
|
+
#### `mintlify dev`
|
|
47
|
+
Run this command at the root of your Mintlify project to preview changes locally.
|
|
51
48
|
|
|
52
49
|
Notes
|
|
53
50
|
|
|
54
51
|
- `mintlify dev` requires `yarn` and it's recommended you install it as a global installation. If you don't have yarn installed already run `npm install --global yarn` in your terminal.
|
|
55
52
|
- `mintlify dev` requires Node v19. Node v20 is currently not supported due to [this bug](https://github.com/TypeStrong/ts-node/issues/1997).
|
|
56
53
|
|
|
57
|
-
|
|
54
|
+
#### Custom Ports
|
|
58
55
|
|
|
59
56
|
Mintlify uses port 3000 by default. You can use the `--port` flag to customize the port Mintlify runs on. For example, use this command to run in port 3333:
|
|
60
57
|
|
|
@@ -73,10 +70,18 @@ Error: listen EADDRINUSE: address already in use :::3000
|
|
|
73
70
|
Steps you can take if the dev CLI is not working (After each step try to run `mintlify dev` again):
|
|
74
71
|
|
|
75
72
|
- Make sure you are running in a folder with a `mint.json` file.
|
|
73
|
+
- Run `npm update -g mintlify` to ensure you have the most recent version of the CLI.
|
|
76
74
|
- Make sure you are using Node v18 or higher.
|
|
77
75
|
- Run `mintlify install` to re-install dependencies.
|
|
78
76
|
- Navigate to the `.mintlify` folder in your home directory and delete its contents.
|
|
79
77
|
|
|
78
|
+
### Additional Commands
|
|
79
|
+
#### `mintlify broken-links` <sup>BETA</sup>
|
|
80
|
+
Check for broken internal links in your Mintlify project.
|
|
81
|
+
|
|
82
|
+
#### `mintlify rename <from> <to>` <sup>BETA</sup>
|
|
83
|
+
Rename a file in a Mintlify project and update all internal link references.
|
|
84
|
+
|
|
80
85
|
### 🏃 Get Started
|
|
81
86
|
|
|
82
87
|
[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": "3.0.
|
|
3
|
+
"version": "3.0.68",
|
|
4
4
|
"description": "Alias for @mintlify/cli",
|
|
5
5
|
"engines": {
|
|
6
6
|
"node": ">=18.0.0"
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
},
|
|
23
23
|
"bin": "index.js",
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@mintlify/cli": "3.0.
|
|
25
|
+
"@mintlify/cli": "3.0.67"
|
|
26
26
|
},
|
|
27
|
-
"gitHead": "
|
|
27
|
+
"gitHead": "83b81e3a5e94a716cc55e0f09f6ada0883afa72f"
|
|
28
28
|
}
|