Skip to content

Commit 2c9d4e6

Browse files
committed
docs: Mintlify CLI, Node LTS note, config filename clarifications
1 parent ac12771 commit 2c9d4e6

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Base Docs are community-managed. We welcome and encourage contributions from eve
2929
3030
## Local development
3131

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.
3333

3434
1. Clone the repository.
3535
2. Install the Mintlify CLI to preview documentation changes locally:
@@ -45,7 +45,7 @@ cd docs
4545
npx mintlify dev
4646
```
4747

48-
Alternatively, without a global install:
48+
Alternatively, without a global install (recommended to avoid global dependencies):
4949

5050
```bash
5151
npx mintlify dev
@@ -54,7 +54,9 @@ npx mintlify dev
5454
### Troubleshooting
5555

5656
- 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)
5860

5961
## How to contribute
6062

0 commit comments

Comments
 (0)