2026-07-06 04:57:23 +00:00
|
|
|
# OpenCode documentation
|
2025-12-05 21:41:35 +00:00
|
|
|
|
2026-07-06 04:57:23 +00:00
|
|
|
The V2 documentation is a Mintlify site deployed from `packages/docs` on the `dev` branch.
|
2025-12-05 21:41:35 +00:00
|
|
|
|
2026-07-06 04:57:23 +00:00
|
|
|
## Local preview
|
2025-12-05 21:41:35 +00:00
|
|
|
|
2026-07-06 04:57:23 +00:00
|
|
|
The Mintlify CLI requires Node.js 20 through 24.
|
2025-12-05 21:41:35 +00:00
|
|
|
|
2026-07-06 04:57:23 +00:00
|
|
|
From this directory, run:
|
2025-12-05 21:41:35 +00:00
|
|
|
|
2026-07-06 04:57:23 +00:00
|
|
|
```bash
|
|
|
|
|
npx mint dev
|
2025-12-05 21:41:35 +00:00
|
|
|
```
|
|
|
|
|
|
2026-07-06 04:57:23 +00:00
|
|
|
The preview opens at `http://localhost:3000` and reloads when MDX or `docs.json` changes.
|
2025-12-05 21:41:35 +00:00
|
|
|
|
2026-07-06 04:57:23 +00:00
|
|
|
Validate changes before opening a pull request:
|
2025-12-05 21:41:35 +00:00
|
|
|
|
2026-07-06 04:57:23 +00:00
|
|
|
```bash
|
|
|
|
|
npx mint validate
|
|
|
|
|
npx mint broken-links
|
|
|
|
|
```
|
2025-12-05 21:42:15 +00:00
|
|
|
|
2026-07-06 04:57:23 +00:00
|
|
|
The hosted preview is available at [opencode.mintlify.site](https://opencode.mintlify.site).
|
