diff --git a/README.md b/README.md index c46e8fd7a..406cfc0e6 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ This is the official documentation platform for the [ReScript](https://rescript- ## System Requirements - `node@22` or higher +- `yarn` or `corepack` ## Setup @@ -26,10 +27,10 @@ yarn yarn rescript # Build the index data. Only needed for initial clone (or content H2 changes) -yarn run update-index +yarn update-index # In a new tab -yarn run dev +yarn dev open localhost:3000 ``` @@ -47,7 +48,7 @@ search terms we need for searching inside the `Belt` docs). You can create your index by running following command: ```sh -yarn run update-index +yarn update-index ``` All the index data is stored in `index_data`, but will not be tracked by git. diff --git a/markdown-pages/docs/manual/installation.mdx b/markdown-pages/docs/manual/installation.mdx index 1773827da..192c02eb7 100644 --- a/markdown-pages/docs/manual/installation.mdx +++ b/markdown-pages/docs/manual/installation.mdx @@ -11,7 +11,7 @@ order: 2 ## Prerequisites
-- [Node.js](https://nodejs.org/) version >= 20 +- [Node.js](https://nodejs.org/) version >= 20.11.0 - One of the following package managers: - [npm](https://docs.npmjs.com/cli/) (comes with Node.js) - [yarn](https://yarnpkg.com/) diff --git a/package.json b/package.json index 218c3cfc8..99a544f7c 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,7 @@ "@node-cli/static-server": "^3.1.4", "@react-router/node": "^7.8.1", "@replit/codemirror-vim": "^6.3.0", - "@rescript/react": "^0.14.0-rc.1", + "@rescript/react": "^0.14.0", "@rescript/webapi": "0.1.0-experimental-29db5f4", "@tsnobip/rescript-lezer": "^0.6.0", "docson": "^2.1.0", @@ -67,7 +67,7 @@ "remark-frontmatter": "^5.0.0", "remark-gfm": "^4.0.1", "remark-validate-links": "^13.1.0", - "rescript": "^12.0.0-rc.5", + "rescript": "^12.0.0", "unified": "^11.0.5", "vfile-matter": "^5.0.0" }, diff --git a/yarn.lock b/yarn.lock index e90b12d1e..54ae51ae2 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1921,35 +1921,35 @@ __metadata: languageName: node linkType: hard -"@rescript/darwin-arm64@npm:12.0.0-rc.5": - version: 12.0.0-rc.5 - resolution: "@rescript/darwin-arm64@npm:12.0.0-rc.5" +"@rescript/darwin-arm64@npm:12.0.0": + version: 12.0.0 + resolution: "@rescript/darwin-arm64@npm:12.0.0" conditions: os=darwin & cpu=arm64 languageName: node linkType: hard -"@rescript/darwin-x64@npm:12.0.0-rc.5": - version: 12.0.0-rc.5 - resolution: "@rescript/darwin-x64@npm:12.0.0-rc.5" +"@rescript/darwin-x64@npm:12.0.0": + version: 12.0.0 + resolution: "@rescript/darwin-x64@npm:12.0.0" conditions: os=darwin & cpu=x64 languageName: node linkType: hard -"@rescript/linux-arm64@npm:12.0.0-rc.5": - version: 12.0.0-rc.5 - resolution: "@rescript/linux-arm64@npm:12.0.0-rc.5" +"@rescript/linux-arm64@npm:12.0.0": + version: 12.0.0 + resolution: "@rescript/linux-arm64@npm:12.0.0" conditions: os=linux & cpu=arm64 languageName: node linkType: hard -"@rescript/linux-x64@npm:12.0.0-rc.5": - version: 12.0.0-rc.5 - resolution: "@rescript/linux-x64@npm:12.0.0-rc.5" +"@rescript/linux-x64@npm:12.0.0": + version: 12.0.0 + resolution: "@rescript/linux-x64@npm:12.0.0" conditions: os=linux & cpu=x64 languageName: node linkType: hard -"@rescript/react@npm:^0.14.0-rc.1": +"@rescript/react@npm:^0.14.0": version: 0.14.0 resolution: "@rescript/react@npm:0.14.0" peerDependencies: @@ -1959,10 +1959,10 @@ __metadata: languageName: node linkType: hard -"@rescript/runtime@npm:12.0.0-rc.5": - version: 12.0.0-rc.5 - resolution: "@rescript/runtime@npm:12.0.0-rc.5" - checksum: 10c0/aff1b5d1969094912cb8d2c0c1f968ba25cfe5c49d5180d82588dcae1ab0866dca35b3166d5f5e03c6138a5be564e10865136e871cb699495be72b51fc8f2b0f +"@rescript/runtime@npm:12.0.0": + version: 12.0.0 + resolution: "@rescript/runtime@npm:12.0.0" + checksum: 10c0/32121f3a78154cf9ab8ae4939819b9807d4a70552d7c2594872f838456c63026eddca4d6b562220fe5431d56afa96e0e276f09e5d9028b15b03f2570a52f1d30 languageName: node linkType: hard @@ -1975,9 +1975,9 @@ __metadata: languageName: node linkType: hard -"@rescript/win32-x64@npm:12.0.0-rc.5": - version: 12.0.0-rc.5 - resolution: "@rescript/win32-x64@npm:12.0.0-rc.5" +"@rescript/win32-x64@npm:12.0.0": + version: 12.0.0 + resolution: "@rescript/win32-x64@npm:12.0.0" conditions: os=win32 & cpu=x64 languageName: node linkType: hard @@ -8119,7 +8119,7 @@ __metadata: "@react-router/dev": "npm:^7.8.1" "@react-router/node": "npm:^7.8.1" "@replit/codemirror-vim": "npm:^6.3.0" - "@rescript/react": "npm:^0.14.0-rc.1" + "@rescript/react": "npm:^0.14.0" "@rescript/webapi": "npm:0.1.0-experimental-29db5f4" "@tailwindcss/vite": "npm:^4.1.13" "@tsnobip/rescript-lezer": "npm:^0.6.0" @@ -8155,7 +8155,7 @@ __metadata: remark-frontmatter: "npm:^5.0.0" remark-gfm: "npm:^4.0.1" remark-validate-links: "npm:^13.1.0" - rescript: "npm:^12.0.0-rc.5" + rescript: "npm:^12.0.0" search-insights: "npm:^2.17.3" tailwindcss: "npm:^4" to-vfile: "npm:^8.0.0" @@ -8169,16 +8169,16 @@ __metadata: languageName: unknown linkType: soft -"rescript@npm:^12.0.0-beta.3, rescript@npm:^12.0.0-rc.5": - version: 12.0.0-rc.5 - resolution: "rescript@npm:12.0.0-rc.5" +"rescript@npm:^12.0.0, rescript@npm:^12.0.0-beta.3": + version: 12.0.0 + resolution: "rescript@npm:12.0.0" dependencies: - "@rescript/darwin-arm64": "npm:12.0.0-rc.5" - "@rescript/darwin-x64": "npm:12.0.0-rc.5" - "@rescript/linux-arm64": "npm:12.0.0-rc.5" - "@rescript/linux-x64": "npm:12.0.0-rc.5" - "@rescript/runtime": "npm:12.0.0-rc.5" - "@rescript/win32-x64": "npm:12.0.0-rc.5" + "@rescript/darwin-arm64": "npm:12.0.0" + "@rescript/darwin-x64": "npm:12.0.0" + "@rescript/linux-arm64": "npm:12.0.0" + "@rescript/linux-x64": "npm:12.0.0" + "@rescript/runtime": "npm:12.0.0" + "@rescript/win32-x64": "npm:12.0.0" dependenciesMeta: "@rescript/darwin-arm64": optional: true @@ -8196,7 +8196,7 @@ __metadata: rescript: cli/rescript.js rescript-legacy: cli/rescript-legacy.js rescript-tools: cli/rescript-tools.js - checksum: 10c0/39cb496077f3f3504ae2b18837fcc38ea4d5de1e351fe6e0d915728403ea229391ab2a82ea72c29e8632eb1790ac60833ccce564c03f4c0293b8c00b14749e58 + checksum: 10c0/8fc92a806d86825fe593cc2c23accc39c95236b4885f9c6d9874fc1b375dd6dd07f8a99ef4c8bbbb273a6f44d47439b5cb4a62577a57ab9ecb0c7ad15021846c languageName: node linkType: hard