Skip to content

Commit e5f0c36

Browse files
committed
Merge branch 'master' of github.com:rescript-lang/rescript-lang.org into delete-legacy-content
2 parents 5902d16 + 9cea1f3 commit e5f0c36

34 files changed

+48660
-12715
lines changed

.github/workflows/pull-request.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ jobs:
88
- uses: actions/setup-node@v4
99
with:
1010
node-version-file: ".node-version"
11-
cache: npm
12-
- run: npm ci
13-
- run: npm run res:build -- --warn-error +3+8+11+12+26+27+31+32+33+34+35+39+44+45+110
14-
- run: npm test
15-
- run: npm run ci:format
11+
cache: yarn
12+
- run: yarn
13+
- run: yarn res:build --warn-error +3+8+11+12+26+27+31+32+33+34+35+39+44+45+110
14+
- run: yarn test
15+
- run: yarn ci:format

.gitignore

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,12 @@ build
4242
mdx-manifest.json
4343

4444
app/**/*.mjs
45-
!_shims.mjs
45+
!_shims.mjs
46+
47+
# Yarn
48+
.yarn/*
49+
!.yarn/patches
50+
!.yarn/plugins
51+
!.yarn/releases
52+
!.yarn/sdks
53+
!.yarn/versions

.prettierignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,6 @@ public/llms/react/**/llm*.txt
4242
pages/docs/**/**/llms.mdx
4343

4444
# prettier refuses to not mess up the installation table
45-
markdown-pages/docs/manual/installation.mdx
45+
markdown-pages/docs/manual/installation.mdx
46+
47+
.yarn/releases/yarn-4.12.0.cjs

patches/react-router-mdx+1.0.8.patch renamed to .yarn/patches/react-router-mdx-npm-1.0.8-d4402c3003.patch

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
diff --git a/node_modules/react-router-mdx/dist/server/index.js b/node_modules/react-router-mdx/dist/server/index.js
1+
diff --git a/dist/server/index.js b/dist/server/index.js
22
index 1e56a6c..b323b05 100644
3-
--- a/node_modules/react-router-mdx/dist/server/index.js
4-
+++ b/node_modules/react-router-mdx/dist/server/index.js
3+
--- a/dist/server/index.js
4+
+++ b/dist/server/index.js
55
@@ -59,15 +59,15 @@ import matter from "gray-matter";
66
import { compile as compileMdx } from "@mdx-js/mdx";
77
import remarkFrontmatter from "remark-frontmatter";

.yarn/releases/yarn-4.12.0.cjs

Lines changed: 942 additions & 0 deletions
Large diffs are not rendered by default.

.yarnrc.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
nodeLinker: node-modules
2+
3+
yarnPath: .yarn/releases/yarn-4.12.0.cjs

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,6 @@ Most of the stuff we want to build can be built as components with Tailwind clas
8484

8585
- Clone the project and follow the [README](README.md) instructions
8686
- Always run the page locally and verify your changes (especially when working on code examples)
87-
- When writing markdown with code examples, always run `npm test` to prevent broken code
87+
- When writing markdown with code examples, always run `yarn test` to prevent broken code
8888
- Feel free to open `Draft PRs` when you are working on bigger features (good for visibility and asking for feedback)
8989
- Improve code based on last feedback until the code is ready to be merged

Makefile

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
SHELL = /bin/bash
22

33
node_modules/.bin/rescript:
4-
npm install
5-
npm run update-index
4+
yarn install
5+
yarn update-index
66

77
build: node_modules/.bin/rescript
88
node_modules/.bin/rescript
9-
npm run update-index
9+
yarn update-index
1010

1111
dev: build
12-
npm run dev
12+
yarn dev
1313

1414
test: build
15-
npm run test
15+
yarn test
1616

1717
clean:
1818
rm -r node_modules lib

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,31 @@ This is the official documentation platform for the [ReScript](https://rescript-
1414

1515
## System Requirements
1616

17-
- `node@20` or higher
18-
- `npm@10` or higher
17+
- `node@22` or higher
18+
- `yarn` or `corepack`
1919

2020
## Setup
2121

2222
```sh
2323
# For first time clone / build (install dependencies)
24-
npm i
24+
yarn
2525

2626
# Initial build
27-
npx rescript
27+
yarn rescript
2828

2929
# Build the index data. Only needed for initial clone (or content H2 changes)
30-
npm run update-index
30+
yarn update-index
3131

3232
# In a new tab
33-
npm run dev
33+
yarn dev
3434

3535
open localhost:3000
3636
```
3737

3838
In case you want to run ReScript in watchmode:
3939

4040
```sh
41-
npx rescript -w
41+
yarn rescript -w
4242
```
4343

4444
## Build Index Data
@@ -48,7 +48,7 @@ search terms we need for searching inside the `Belt` docs). You can create your
4848
index by running following command:
4949

5050
```sh
51-
npm run update-index
51+
yarn update-index
5252
```
5353

5454
All the index data is stored in `index_data`, but will not be tracked by git.
@@ -120,7 +120,7 @@ node scripts/test-hrefs.mjs "pages/docs/manual/**/*.mdx"
120120

121121
### Continous Integration
122122

123-
Always make sure to run `npm test` before pushing any content, otherwise our CI
123+
Always make sure to run `yarn test` before pushing any content, otherwise our CI
124124
might trigger a failure warning. Failing branches are very unlikely to be merged.
125125

126126
## Design / UX

app/root.res

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ let default = () => {
5858
<link rel="stylesheet" href={utilsCss} />
5959
<link rel="icon" href="/favicon.ico" />
6060
<Links />
61-
<Meta />
61+
<ReactRouter.Meta />
6262
<meta
6363
name="viewport"
6464
content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, minimal-ui"

0 commit comments

Comments
 (0)