Skip to content

Commit 752e1aa

Browse files
committed
Update dependencies to Docusaurus 3 and React 18, adjust Node.js version requirement, and fix documentation formatting
1 parent 58ffc4f commit 752e1aa

7 files changed

Lines changed: 14066 additions & 16798 deletions

File tree

.node-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
16.14
1+
22.14

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
Website for rescript-react-native
44

5-
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
5+
This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
6+
7+
Requires **Node.js 18+** (see `.node-version`).
68

79
## Installation
810

docs/packager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ returns a type `Packager.required`.
1212
let asset = Packager.require("./some/asset.jpg")
1313
```
1414

15-
You can use this for component like [Image](docs/image/).
15+
You can use this for component like [Image](./image).

docs/platformcolor.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Functions to access native colors on the target platform by supplying the native
1616
get: Ios.t => Color.t
1717
```
1818

19-
#### Ios.get{n}
19+
#### Ios.get\{n\}
2020

2121
Methods to send fallbacks.
2222

@@ -46,9 +46,9 @@ See: [R.color](https://developer.android.com/reference/android/R.color)
4646

4747
Allow to get color or attr.
4848

49-
#### Android.get{n}
49+
#### Android.get\{n\}
5050

51-
You may want to get multiple platform colors in case one is not supported by the system. In this case, you can use the `get{n}` function to retrieve the values. You can mix and match Android color and attributes in this call. The first value will be treated as default and rest will be treated as fallback.
51+
You may want to get multiple platform colors in case one is not supported by the system. In this case, you can use the `get\{n\}` function to retrieve the values. You can mix and match Android color and attributes in this call. The first value will be treated as default and rest will be treated as fallback.
5252

5353
Defined up to 7 arguments.
5454

@@ -60,15 +60,15 @@ Depending on platform & OS version (and for Android you can have user-defined at
6060
unsafeGet: string => Color.t
6161
```
6262

63-
### unsafeGet{n}
63+
### unsafeGet\{n\}
6464

65-
The unsafe version of `get{n}` where a string can be passed in. This can be any Android resource query, for example: `?attr/colorPrimary` or `?android:attr/colorPrimary`, even resources defined within your Android app. The first value will be treated as default and rest will be treated as fallback.
65+
The unsafe version of `get\{n\}` where a string can be passed in. This can be any Android resource query, for example: `?attr/colorPrimary` or `?android:attr/colorPrimary`, even resources defined within your Android app. The first value will be treated as default and rest will be treated as fallback.
6666

6767
Defined up to 7 arguments.
6868

6969
### unsafeGetMultiple
7070

71-
The array version of `unsafeGet{n}` supporting arbitrary number of fallbacks.
71+
The array version of `unsafeGet\{n\}` supporting arbitrary number of fallbacks.
7272

7373
```rescript
7474
unsafeGetMultiple: array(string) => Color.t

docusaurus.config.js

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
/** @type {import('@docusaurus/types').DocusaurusConfig} */
2-
1+
/** @type {import('@docusaurus/types').Config} */
32
module.exports = {
43
title: "ReScript React Native",
54
tagline: "The safest way to build React Native apps",
65
url: "https://rescript-react-native.github.io",
76
baseUrl: "/",
87
onBrokenLinks: "throw",
9-
onBrokenMarkdownLinks: "throw",
8+
markdown: {
9+
hooks: {
10+
onBrokenMarkdownLinks: "throw",
11+
},
12+
},
1013
favicon: "favicon.ico",
1114
organizationName: "rescript-react-native",
1215
projectName: "rescript-react-native.github.io",
@@ -15,8 +18,6 @@ module.exports = {
1518
appId: "W7CN8UK6UO",
1619
apiKey: "6e1574674c062e3d14ab7c888da88f4f",
1720
indexName: "rescript-react-native",
18-
// contextualSearch: true,
19-
// searchParameters: {},
2021
},
2122
navbar: {
2223
style: "dark",
@@ -29,7 +30,6 @@ module.exports = {
2930
{
3031
label: "Docs",
3132
to: "docs/",
32-
activeBasePath: "docs",
3333
position: "left",
3434
},
3535
{
@@ -125,6 +125,8 @@ module.exports = {
125125
},
126126
blog: {
127127
showReadingTime: true,
128+
onInlineAuthors: "ignore",
129+
onUntruncatedBlogPosts: "ignore",
128130
editUrl:
129131
"https://github.com/rescript-react-native/rescript-react-native.github.io/edit/src/",
130132
},

0 commit comments

Comments
 (0)