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: README.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ Base Docs are community-managed. We welcome and encourage contributions from eve
29
29
30
30
## Local development
31
31
32
-
Prerequisite: Node.js 18.17+ (LTS recommended). Tested with Node 20/22.
32
+
Prerequisite: Node.js 18.17+ (LTS recommended). Also tested with Node 20 and 22.
33
33
34
34
1. Clone the repository.
35
35
2. Install the Mintlify CLI to preview documentation changes locally:
@@ -45,7 +45,7 @@ cd docs
45
45
npx mintlify dev
46
46
```
47
47
48
-
Alternatively, without a global install:
48
+
Alternatively, without a global install (recommended to avoid global dependencies):
49
49
50
50
```bash
51
51
npx mintlify dev
@@ -54,7 +54,9 @@ npx mintlify dev
54
54
### Troubleshooting
55
55
56
56
- Ensure Node.js 18.17+ is installed and that you run `npx mintlify dev` from the directory containing your Mintlify config (`docs.json` or `mint.json`) (usually `docs/`).
57
-
- Local preview differs from production: run `npx mintlify update` to update the CLI.
57
+
- If local preview differs from production, run the latest CLI:
58
+
-`npx mintlify@latest dev` (no global install), or
59
+
-`npm i -g mintlify@latest` (to update a global install)
0 commit comments