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
+13-11Lines changed: 13 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,37 +29,39 @@ Base Docs are community-managed. We welcome and encourage contributions from eve
29
29
30
30
## Local development
31
31
32
-
Prerequisite: Node.js v19+.
32
+
Prerequisite: Node.js 18.17+ (LTS recommended). Also tested with Node 20 and 22.
33
33
34
34
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:
36
36
37
37
```bash
38
-
npm i -g mint
38
+
npm i -g mintlify
39
39
```
40
40
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):
42
42
43
43
```bash
44
44
cd docs
45
-
mint dev
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
-
npx mint dev
51
+
npx mintlify dev
52
52
```
53
53
54
54
### Troubleshooting
55
55
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)
58
60
59
61
## How to contribute
60
62
61
63
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.
63
65
3.**Open a pull request**: Provide a clear summary and links to related pages. The docs team and community will review.
64
66
65
67
> 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
163
165
164
166
## Storybook for UI components
165
167
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