Skip to content

Commit b481c0e

Browse files
committed
chore: generate markdown docs from jsdocs
1 parent 73fda1e commit b481c0e

File tree

7 files changed

+13
-7
lines changed

7 files changed

+13
-7
lines changed

docs/api/components/Form.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/do
2020

2121
## Summary
2222

23-
[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.Form.html)
23+
[Reference Documentation ↗](https://api.reactrouter.com/v7/variables/react_router.Form.html)
2424

2525
A progressively enhanced HTML [`<form>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form)
2626
that submits data to actions via [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/fetch),

docs/api/components/Link.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/do
2020

2121
## Summary
2222

23-
[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.Link.html)
23+
[Reference Documentation ↗](https://api.reactrouter.com/v7/variables/react_router.Link.html)
2424

2525
A progressively enhanced [`<a href>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a)
2626
wrapper to enable navigation with client-side routing.

docs/api/components/NavLink.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/do
2020

2121
## Summary
2222

23-
[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.NavLink.html)
23+
[Reference Documentation ↗](https://api.reactrouter.com/v7/variables/react_router.NavLink.html)
2424

2525
Wraps [`<Link>`](../components/Link) with additional props for styling active and
2626
pending states.

docs/api/data-routers/RouterProvider.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ createRoot(document.getElementById("root")).render(
3636
);
3737
```
3838

39+
<docs-info>Please note that this component is exported both from `react-router` and
40+
`react-router/dom` with the only difference being that the latter automatically
41+
wires up the `react-dom` `flushSync` implementation. You _almost always_ want
42+
to use the version from `react-router/dom` unless you're running in a non-DOM
43+
environment.</docs-info>
44+
3945
## Signature
4046

4147
```tsx

docs/api/framework-routers/HydratedRouter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ function HydratedRouter(props: HydratedRouterProps)
3333

3434
### unstable_getContext
3535

36-
Context object to be passed through to [`createBrowserRouter`](../data-routers/createBrowserRouter) and made available to
37-
[`clientAction`](../../start/framework/route-module#clientAction)/[`clientLoader`](../../start/framework/route-module#clientLoader)
36+
Context object to be passed through to [`createBrowserRouter`](../data-routers/createBrowserRouter) and made
37+
available to [`clientAction`](../../start/framework/route-module#clientAction)/[`clientLoader`](../../start/framework/route-module#clientLoader)
3838
functions
3939

docs/api/rsc/matchRSCServerRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ to release notes for relevant changes.</docs-warning>
2828

2929
## Summary
3030

31-
[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.unstable_matchRSCServerRequest.html)
31+
[Reference Documentation ↗](https://api.reactrouter.com/v7/variables/react_router.unstable_matchRSCServerRequest.html)
3232

3333
Matches the given routes to a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request)
3434
and returns an [RSC](https://react.dev/reference/rsc/server-components)

docs/api/utils/createRoutesFromElements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/co
2020

2121
## Summary
2222

23-
[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.createRoutesFromElements.html)
23+
[Reference Documentation ↗](https://api.reactrouter.com/v7/variables/react_router.createRoutesFromElements.html)
2424

2525
Create route objects from JSX elements instead of arrays of objects.
2626

0 commit comments

Comments
 (0)