Skip to content

Commit 0cea268

Browse files
MichaelDeBoeyMichaelDeBoey
committed
chore: generate markdown docs from jsdocs
1 parent 63808a7 commit 0cea268

25 files changed

+405
-338
lines changed

‎docs/api/components/Form.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/do
2323
[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.Form.html)
2424

2525
A progressively enhanced HTML [`<form>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form)
26-
that submits data to actions via [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API),
26+
that submits data to actions via [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/fetch),
2727
activating pending states in [`useNavigation`](../hooks/useNavigation) which enables advanced
2828
user interfaces beyond a basic HTML [`<form>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form).
2929
After a form's `action` completes, all data on the page is automatically
@@ -37,7 +37,8 @@ enabling web application user experiences.
3737

3838
`Form` is most useful for submissions that should also change the URL or
3939
otherwise add an entry to the browser history stack. For forms that shouldn't
40-
manipulate the browser history stack, use [`<fetcher.Form>`][fetcher_form].
40+
manipulate the browser [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History)
41+
stack, use `<fetcher.Form>`.
4142

4243
```tsx
4344
import { Form } from "react-router";

‎docs/api/components/Links.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,10 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/do
2222

2323
[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.Links.html)
2424

25-
Renders all of the `<link>` tags created by the route module
26-
[`links`](../../start/framework/route-module#links) export. You should render
27-
it inside the `<head>` of your document.
25+
Renders all the [`<link>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link)
26+
tags created by the route module's [`links`](../../start/framework/route-module#links)
27+
export. You should render it inside the [`<head>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/head)
28+
of your document.
2829

2930
```tsx
3031
import { Links } from "react-router";

‎docs/api/components/Meta.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,10 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/do
2222

2323
[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.Meta.html)
2424

25-
Renders all the `<meta>` tags created by the route module
26-
[`meta`](../../start/framework/route-module#meta) exports. You should render
27-
it inside the `<head>` of your HTML.
25+
Renders all the [`<meta>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta)
26+
tags created by the route module's [`meta`](../../start/framework/route-module#meta)
27+
export. You should render it inside the [`<head>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/head)
28+
of your document.
2829

2930
```tsx
3031
import { Meta } from "react-router";

‎docs/api/components/PrefetchPageLinks.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/do
2222

2323
[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.PrefetchPageLinks.html)
2424

25-
Renders `<link rel=prefetch|modulepreload>` tags for modules and data of
26-
another page to enable an instant navigation to that page.
27-
[`<Link prefetch>`](../../components/Link#prefetch) uses this internally, but
28-
you can render it to prefetch a page for any other reason.
25+
Renders [`<link rel=prefetch|modulepreload>`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLinkElement/rel)
26+
tags for modules and data of another page to enable an instant navigation to
27+
that page. [`<Link prefetch>`](./Link#prefetch) uses this internally, but you
28+
can render it to prefetch a page for any other reason.
2929

3030
For example, you may render one of this as the user types into a search field
3131
to prefetch search results before they click through to their selection.
@@ -50,6 +50,9 @@ The absolute path of the page to prefetch, e.g. `/absolute/path`.
5050

5151
### dataLinkProps
5252

53-
Additional props to pass to the [`<link>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/link)
54-
tag, such as `crossOrigin`, `integrity`, `rel`, etc.
53+
Additional props to pass to the [`<link>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link)
54+
tag, such as [`crossOrigin`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLinkElement/crossOrigin),
55+
[`integrity`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLinkElement/integrity),
56+
[`rel`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLinkElement/rel),
57+
etc.
5558

‎docs/api/components/Scripts.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/do
2323
[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.Scripts.html)
2424

2525
Renders the client runtime of your app. It should be rendered inside the
26-
[`<body>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/body)
26+
[`<body>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/body)
2727
of the document.
2828

2929
If server rendering, you can omit `<Scripts/>` and the app will work as a
@@ -55,6 +55,8 @@ function Scripts(props: ScriptsProps): React.JSX.Element | null
5555

5656
### props
5757

58-
Props for the [`<script>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/script)
59-
tag, such as `crossOrigin`, `nonce`, etc.
58+
Props for the [`<script>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script)
59+
tags, such as [`crossOrigin`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLScriptElement/crossOrigin),
60+
[`nonce`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/nonce),
61+
etc.
6062

‎docs/api/components/ScrollRestoration.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,8 @@ to `location.key`. See [`GetScrollRestorationKeyFunction`](https://api.reactrout
7979
### nonce
8080

8181
A [`nonce`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/nonce)
82-
attribute to render on [the `<script>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/script)
82+
attribute to render on the [`<script>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script)
83+
element
8384

8485
### storageKey
8586

‎docs/api/data-routers/StaticRouterProvider.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/do
2222

2323
[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.StaticRouterProvider.html)
2424

25-
A Data Router that may not navigate to any other location. This is useful
26-
on the server where there is no stateful UI.
25+
A [`DataRouter`](https://api.reactrouter.com/v7/interfaces/react_router.DataRouter.html) that may not navigate to any other [`Location`](https://api.reactrouter.com/v7/interfaces/react_router.Location.html).
26+
This is useful on the server where there is no stateful UI.
2727

2828
```tsx
2929
export async function handleRequest(request: Request) {
@@ -57,17 +57,20 @@ function StaticRouterProvider({
5757

5858
### context
5959

60-
The [`StaticHandlerContext`](https://api.reactrouter.com/v7/interfaces/react_router.StaticHandlerContext.html) returned from `staticHandler.query()`
61-
62-
### router
63-
64-
The static data router from [`createStaticRouter`](../data-routers/createStaticRouter)
60+
The [`StaticHandlerContext`](https://api.reactrouter.com/v7/interfaces/react_router.StaticHandlerContext.html) returned from [`StaticHandler`](https://api.reactrouter.com/v7/interfaces/react_router.StaticHandler.html)'s
61+
`query`
6562

6663
### hydrate
6764

6865
Whether to hydrate the router on the client (default `true`)
6966

7067
### nonce
7168

72-
The [`nonce`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/nonce) to use for the hydration `<script>` tag
69+
The [`nonce`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/nonce)
70+
to use for the hydration [`<script>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script)
71+
tag
72+
73+
### router
74+
75+
The static [`DataRouter`](https://api.reactrouter.com/v7/interfaces/react_router.DataRouter.html) from [`createStaticRouter`](../data-routers/createStaticRouter)
7376

0 commit comments

Comments
 (0)