Skip to content

Commit 5854a59

Browse files
committed
docs: Mintlify CLI, Node LTS, config filename clarifications
1 parent a50359f commit 5854a59

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

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

32-
Prerequisite: Node.js v19+.
32+
Prerequisite: Node.js 18.17+ (LTS recommended). Also tested with Node 20 and 22.
3333

3434
1. Clone the repository.
35-
2. Install the Mint CLI to preview documentation changes locally:
35+
2. Install the Mintlify CLI to preview documentation changes locally:
3636

3737
```bash
38-
npm i -g mint
38+
npm i -g mintlify
3939
```
4040

41-
3. Preview locally (run from the `docs/` directory where `docs.json` lives):
41+
3. Preview locally (run from the `docs/` directory where your Mintlify config (`docs.json` or `mint.json`) lives):
4242

4343
```bash
4444
cd docs
45-
mint dev
45+
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
51-
npx mint dev
51+
npx mintlify dev
5252
```
5353

5454
### Troubleshooting
5555

56-
- Ensure Node.js v19+ is installed and that you run `mint dev` from the directory containing `docs.json` (usually `docs/`).
57-
- Local preview differs from production: run `mint update` to update the CLI.
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+
- 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

6163
1. **Fork and branch**: Fork `base/docs` and create a descriptive branch for your change.
62-
2. **Edit content in `docs/`**: Follow the structure and style guidelines below. Preview locally with the Mint CLI.
64+
2. **Edit content in `docs/`**: Follow the structure and style guidelines below. Preview locally with the Mintlify CLI.
6365
3. **Open a pull request**: Provide a clear summary and links to related pages. The docs team and community will review.
6466

6567
> Tip: Prefer small, focused PRs. Link related guides and references directly in your content.
@@ -163,4 +165,4 @@ The core team will review opened PRs. The SLA is 2 weeks, generally on a first-c
163165

164166
## Storybook for UI components
165167

166-
See `storybook/README.md` for details on local Storybook and component docs.
168+
See `storybook/README.md` for details on local Storybook and component docs.

0 commit comments

Comments
 (0)