Skip to content

Commit db81a45

Browse files
authoredMay 5, 2021
Merge pull request #320 from rescript-association/upgrade-deps
Upgrade deps
2 parents 8f54a33 + 879da52 commit db81a45

File tree

144 files changed

+8667
-9604
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

144 files changed

+8667
-9604
lines changed
 

‎.github/workflows/pull-request.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ jobs:
99
- uses: actions/setup-node@v2
1010
with:
1111
node-version: 14.x
12-
- run: yarn --frozen-lockfile
13-
- run: yarn run bs:build
14-
- run: yarn test
12+
- run: npm ci
13+
- run: npx rescript
14+
- run: npm test

‎README.md

+15-7
Original file line numberDiff line numberDiff line change
@@ -15,28 +15,36 @@ This is the official documentation platform for the [ReScript](https://rescript-
1515
- Create an issue to let us know what you are missing
1616
- In case you want to contribute missing docs, please refer to our [Contribution section](#contributing)
1717

18+
## System Requirements
19+
20+
- `node@12.22.1` or higher (for ES6 module compat)
21+
- `npm@6` (package-lock v1)
22+
1823
## Setup
1924

2025
```sh
2126
# For first time clone / build (install dependencies)
22-
yarn
27+
npm i
28+
29+
# Only needed for initial clone (or content H2 changes)
30+
npm run update-index
2331

2432
# Initial build
25-
yarn bs:build
33+
npm run res:build
2634

2735
# Build the index data
28-
yarn run update-index
36+
npm run update-index
2937

3038
# In a new tab
31-
yarn dev
39+
npm run dev
3240

3341
# then open localhost:3000
3442
```
3543

3644
In case you want to run ReScript in watchmode:
3745

3846
```sh
39-
yarn run bs:start
47+
npm run res:start
4048
```
4149

4250
## Build Index Data
@@ -46,7 +54,7 @@ search terms we need for searching inside the `Belt` docs). You can create your
4654
index by running following command:
4755

4856
```sh
49-
yarn run update-index
57+
npm run update-index
5058
```
5159

5260
All the index data is stored in `index_data`, but will not be tracked by git.
@@ -149,7 +157,7 @@ posts](https://rescript-lang.org/blogpost-guide).
149157
**Quick-takeaways:**
150158

151159
- Blogposts are located in `_blogposts`
152-
- Author metadata is located in `data/blog_authors.json`
160+
- Author metadata is located in `data/blog_authors.mjs`
153161
- Make sure to follow the file naming rules
154162

155163
### Contributing

0 commit comments

Comments
 (0)
Please sign in to comment.