Skip to content

Commit 716be85

Browse files
committed
chore: generate markdown docs from jsdocs
1 parent 7a9ff8c commit 716be85

File tree

2 files changed

+14
-16
lines changed

2 files changed

+14
-16
lines changed

docs/api/rsc/RSCStaticRouter.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ unstable: true
66
# unstable_RSCStaticRouter
77

88
<!--
9-
⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
9+
⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
1010
1111
Thank you for helping improve our documentation!
1212
@@ -22,8 +22,8 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/rs
2222
<br />
2323
<br />
2424

25-
<docs-warning>This API is experimental and subject to breaking changes in
26-
minor/patch releases. Please use with caution and pay **very** close attention
25+
<docs-warning>This API is experimental and subject to breaking changes in
26+
minor/patch releases. Please use with caution and pay **very** close attention
2727
to release notes for relevant changes.</docs-warning>
2828

2929
## Summary
@@ -53,7 +53,7 @@ routeRSCServerRequest({
5353
{
5454
bootstrapScriptContent,
5555
formState: await payload.formState,
56-
},
56+
}
5757
);
5858
},
5959
});
@@ -62,9 +62,7 @@ routeRSCServerRequest({
6262
## Signature
6363

6464
```tsx
65-
function RSCStaticRouter({
66-
getPayload,
67-
}: RSCStaticRouterProps);
65+
function RSCStaticRouter({ getPayload }: RSCStaticRouterProps)
6866
```
6967

7068
## Props
@@ -73,3 +71,4 @@ function RSCStaticRouter({
7371

7472
A function that starts decoding of the [`unstable_RSCPayload`](https://api.reactrouter.com/v7/types/react_router.unstable_RSCPayload.html). Usually passed
7573
through from [`unstable_routeRSCServerRequest`](../rsc/routeRSCServerRequest)'s `renderHTML`.
74+

docs/api/rsc/routeRSCServerRequest.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ unstable: true
66
# unstable_routeRSCServerRequest
77

88
<!--
9-
⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
9+
⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
1010
1111
Thank you for helping improve our documentation!
1212
@@ -22,8 +22,8 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/rs
2222
<br />
2323
<br />
2424

25-
<docs-warning>This API is experimental and subject to breaking changes in
26-
minor/patch releases. Please use with caution and pay **very** close attention
25+
<docs-warning>This API is experimental and subject to breaking changes in
26+
minor/patch releases. Please use with caution and pay **very** close attention
2727
to release notes for relevant changes.</docs-warning>
2828

2929
## Summary
@@ -55,7 +55,7 @@ routeRSCServerRequest({
5555
{
5656
bootstrapScriptContent,
5757
formState: await payload.formState,
58-
},
58+
}
5959
);
6060
},
6161
});
@@ -76,11 +76,9 @@ async function routeRSCServerRequest({
7676
createFromReadableStream: SSRCreateFromReadableStreamFunction;
7777
renderHTML: (
7878
getPayload: () => DecodedPayload,
79-
) =>
80-
| ReadableStream<Uint8Array>
81-
| Promise<ReadableStream<Uint8Array>>;
79+
) => ReadableStream<Uint8Array> | Promise<ReadableStream<Uint8Array>>;
8280
hydrate?: boolean;
83-
}): Promise<Response>;
81+
}): Promise<Response>
8482
```
8583

8684
## Params
@@ -91,7 +89,7 @@ Your `react-server-dom-xyz/client`'s `createFromReadableStream` function, used t
9189

9290
### opts.serverResponse
9391

94-
A Response from the [RSC](https://react.dev/reference/rsc/server-components) handler containing a serialized [`unstable_RSCPayload`](https://api.reactrouter.com/v7/types/react_router.unstable_RSCPayload.html).
92+
A Response or partial response generated by the [RSC](https://react.dev/reference/rsc/server-components) handler containing a serialized [`unstable_RSCPayload`](https://api.reactrouter.com/v7/types/react_router.unstable_RSCPayload.html).
9593

9694
### opts.hydrate
9795

@@ -110,3 +108,4 @@ The request to route.
110108
A [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
111109
that either contains the [RSC](https://react.dev/reference/rsc/server-components)
112110
payload for data requests, or renders the HTML for document requests.
111+

0 commit comments

Comments
 (0)