chore: generate markdown docs from jsdocs

Author: remix-run-bot

docs/api/components/Await.md

@@ -24,7 +24,7 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/co
 
 Used to render promise values with automatic error handling.
 
-**Note:** `<Await>` expects to be rendered inside of a `<React.Suspense>`
+**Note:** `<Await>` expects to be rendered inside a [`<React.Suspense>`](https://react.dev/reference/react/Suspense)
 
 ```tsx
 import { Await, useLoaderData } from "react-router";
@@ -97,7 +97,8 @@ function Reviews() {
 
 ### errorElement
 
-The error element renders instead of the children when the promise rejects.
+The error element renders instead of the `children` when the [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
+rejects.
 
 ```tsx
 <Await
@@ -125,16 +126,18 @@ function ReviewsError() {
 }
 ```
 
-If you do not provide an errorElement, the rejected value will bubble up to
-the nearest route-level `ErrorBoundary` and be accessible via the
-[`useRouteError`](../hooks/useRouteError) hook.
+If you do not provide an `errorElement`, the rejected value will bubble up
+to the nearest route-level [`ErrorBoundary`](../../start/framework/route-module#errorboundary)
+and be accessible via the [`useRouteError`](../hooks/useRouteError) hook.
 
 ### resolve
 
-Takes a promise returned from a `loader` to be resolved and rendered.
+Takes a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
+returned from a [`loader`](../../start/framework/route-module#loader) to be
+resolved and rendered.
 
-```jsx
-import { useLoaderData, Await } from "react-router";
+```tsx
+import { Await, useLoaderData } from "react-router";
 
 export async function loader() {
   let reviews = getReviews(); // not awaited

docs/api/components/Form.md

@@ -22,11 +22,22 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/do
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.Form.html)
 
-A progressively enhanced HTML [`<form>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form) that submits data to actions via `fetch`, activating pending states in `useNavigation` which enables advanced user interfaces beyond a basic HTML form. After a form's action completes, all data on the page is automatically revalidated to keep the UI in sync with the data.
-
-Because it uses the HTML form API, server rendered pages are interactive at a basic level before JavaScript loads. Instead of React Router managing the submission, the browser manages the submission as well as the pending states (like the spinning favicon). After JavaScript loads, React Router takes over enabling web application user experiences.
-
-Form is most useful for submissions that should also change the URL or otherwise add an entry to the browser history stack. For forms that shouldn't manipulate the browser history stack, use [`<fetcher.Form>`][fetcher_form].
+A progressively enhanced HTML [`<form>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form)
+that submits data to actions via [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API),
+activating pending states in [`useNavigation`](../hooks/useNavigation) which enables advanced
+user interfaces beyond a basic HTML [`<form>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form).
+After a form's `action` completes, all data on the page is automatically
+revalidated to keep the UI in sync with the data.
+
+Because it uses the HTML form API, server rendered pages are interactive at a
+basic level before JavaScript loads. Instead of React Router managing the
+submission, the browser manages the submission as well as the pending states
+(like the spinning favicon). After JavaScript loads, React Router takes over
+enabling web application user experiences.
+
+`Form` is most useful for submissions that should also change the URL or
+otherwise add an entry to the browser history stack. For forms that shouldn't
+manipulate the browser history stack, use [`<fetcher.Form>`][fetcher_form].
 
 ```tsx
 import { Form } from "react-router";
@@ -45,7 +56,7 @@ function NewEvent() {
 
 ### action
 
-The URL to submit the form data to.  If `undefined`, this defaults to the
+The URL to submit the form data to. If `undefined`, this defaults to the
 closest route in context.
 
 ### discover
@@ -81,8 +92,9 @@ can pick up the fetcher's state in a different component in a [`useFetcher`](../
 The HTTP verb to use when the form is submitted. Supports "get", "post",
 "put", "delete", and "patch".
 
-Native `<form>` only supports `get` and `post`, avoid the other verbs if
-you'd like to support progressive enhancement
+Native [`<form>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form)
+only supports `get` and `post`, avoid the other verbs if you'd like to
+support progressive enhancement
 
 ### navigate
 
@@ -93,39 +105,41 @@ you don't care about the resulting data in this component.
 ### onSubmit
 
 A function to call when the form is submitted. If you call
-`event.preventDefault()` then this form will not do anything.
+[`event.preventDefault()`](https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
+then this form will not do anything.
 
 ### preventScrollReset
 
 Prevent the scroll position from resetting to the top of the viewport on
-completion of the navigation when using the <ScrollRestoration> component
+completion of the navigation when using the
+``<ScrollRestoration>`` component
 
 ### relative
 
 Determines whether the form action is relative to the route hierarchy or
-the pathname.  Use this if you want to opt out of navigating the route
+the pathname. Use this if you want to opt out of navigating the route
 hierarchy and want to instead route based on slash-delimited URL segments.
 See [`RelativeRoutingType`](https://api.reactrouter.com/v7/types/react_router.RelativeRoutingType.html).
 
 ### reloadDocument
 
-Forces a full document navigation instead of client side routing + data
+Forces a full document navigation instead of client side routing and data
 fetch.
 
 ### replace
 
-Replaces the current entry in the browser history stack when the form
-navigates. Use this if you don't want the user to be able to click "back"
-to the page with the form on it.
+Replaces the current entry in the browser [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History)
+stack when the form navigates. Use this if you don't want the user to be
+able to click "back" to the page with the form on it.
 
 ### state
 
-State object to add to the history stack entry for this navigation
+State object to add to the [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History)
+stack entry for this navigation
 
 ### viewTransition
 
-Enables a [View
-Transition](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API)
-for this navigation. To apply specific styles during the transition see
+Enables a [View Transition](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API)
+for this navigation. To apply specific styles during the transition, see
 [`useViewTransitionState`](../hooks/useViewTransitionState).
 

docs/api/components/Link.md

@@ -22,7 +22,8 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/do
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.Link.html)
 
-A progressively enhanced `<a href>` wrapper to enable navigation with client-side routing.
+A progressively enhanced [`<a href>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a)
+wrapper to enable navigation with client-side routing.
 
 ```tsx
 import { Link } from "react-router";
@@ -74,8 +75,8 @@ Defines the data and module prefetching behavior for the link.
 - **render** - prefetches when the link renders
 - **viewport** - prefetches when the link is in the viewport, very useful for mobile
 
-Prefetching is done with HTML `<link rel="prefetch">` tags. They are inserted
-after the link.
+Prefetching is done with HTML [`<link rel="prefetch">`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link)
+tags. They are inserted after the link.
 
 ```tsx
 <a href="..." />
@@ -93,7 +94,7 @@ Because of this, if you are using `nav :last-child` you will need to use
 
 Prevents the scroll position from being reset to the top of the window when
 the link is clicked and the app is using [`ScrollRestoration`](../components/ScrollRestoration). This only
-prevents new locations reseting scroll to the top, scroll position will be
+prevents new locations resetting scroll to the top, scroll position will be
 restored for back/forward button navigation.
 
 ```tsx
@@ -112,14 +113,14 @@ Defines the relative path behavior for the link.
 <Link relative="path" />
 ```
 
-Consider a route hierarchy where a parent route pattern is "blog" and a child
-route pattern is "blog/:slug/edit".
+Consider a route hierarchy where a parent route pattern is `"blog"` and a child
+route pattern is `"blog/:slug/edit"`.
 
 - **route** - default, resolves the link relative to the route pattern. In the
-example above a relative link of `".."` will remove both `:slug/edit` segments
-back to "/blog".
-- **path** - relative to the path so `..` will only remove one URL segment up
-to "/blog/:slug"
+example above, a relative link of `".."` will remove both `:slug/edit` segments
+back to `"/blog"`.
+- **path** - relative to the path so `".."` will only remove one URL segment up
+to `"/blog/:slug"`
 
 Note that index routes and layout routes do not have paths so they are not
 included in the relative path calculation.
@@ -129,7 +130,8 @@ included in the relative path calculation.
 [modes: framework, data, declarative]
 
 Will use document navigation instead of client side routing when the link is
-clicked: the browser will handle the transition normally (as if it were an `<a href>`).
+clicked: the browser will handle the transition normally (as if it were an
+[`<a href>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a)).
 
 ```tsx
 <Link to="/logout" reloadDocument />
@@ -139,8 +141,8 @@ clicked: the browser will handle the transition normally (as if it were an `<a h
 
 [modes: framework, data, declarative]
 
-Replaces the current entry in the history stack instead of pushing a new one
-onto it.
+Replaces the current entry in the [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History)
+stack instead of pushing a new one  onto it.
 
 ```tsx
 <Link replace />

docs/api/components/NavLink.md

@@ -80,7 +80,7 @@ Can be regular React children or a function that receives an object with the
 
 [modes: framework, data, declarative]
 
-Classes are automatically applied to NavLink that correspond to the state.
+Classes are automatically applied to `NavLink` that correspond to the state.
 
 ```css
 a.active {
@@ -158,8 +158,8 @@ Defines the data and module prefetching behavior for the link.
 - **render** - prefetches when the link renders
 - **viewport** - prefetches when the link is in the viewport, very useful for mobile
 
-Prefetching is done with HTML `<link rel="prefetch">` tags. They are inserted
-after the link.
+Prefetching is done with HTML [`<link rel="prefetch">`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link)
+tags. They are inserted after the link.
 
 ```tsx
 <a href="..." />
@@ -177,7 +177,7 @@ Because of this, if you are using `nav :last-child` you will need to use
 
 Prevents the scroll position from being reset to the top of the window when
 the link is clicked and the app is using [`ScrollRestoration`](../components/ScrollRestoration). This only
-prevents new locations reseting scroll to the top, scroll position will be
+prevents new locations resetting scroll to the top, scroll position will be
 restored for back/forward button navigation.
 
 ```tsx
@@ -196,14 +196,14 @@ Defines the relative path behavior for the link.
 <Link relative="path" />
 ```
 
-Consider a route hierarchy where a parent route pattern is "blog" and a child
-route pattern is "blog/:slug/edit".
+Consider a route hierarchy where a parent route pattern is `"blog"` and a child
+route pattern is `"blog/:slug/edit"`.
 
 - **route** - default, resolves the link relative to the route pattern. In the
-example above a relative link of `".."` will remove both `:slug/edit` segments
-back to "/blog".
-- **path** - relative to the path so `..` will only remove one URL segment up
-to "/blog/:slug"
+example above, a relative link of `".."` will remove both `:slug/edit` segments
+back to `"/blog"`.
+- **path** - relative to the path so `".."` will only remove one URL segment up
+to `"/blog/:slug"`
 
 Note that index routes and layout routes do not have paths so they are not
 included in the relative path calculation.
@@ -213,7 +213,8 @@ included in the relative path calculation.
 [modes: framework, data, declarative]
 
 Will use document navigation instead of client side routing when the link is
-clicked: the browser will handle the transition normally (as if it were an `<a href>`).
+clicked: the browser will handle the transition normally (as if it were an
+[`<a href>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a)).
 
 ```tsx
 <Link to="/logout" reloadDocument />
@@ -223,8 +224,8 @@ clicked: the browser will handle the transition normally (as if it were an `<a h
 
 [modes: framework, data, declarative]
 
-Replaces the current entry in the history stack instead of pushing a new one
-onto it.
+Replaces the current entry in the [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History)
+stack instead of pushing a new one  onto it.
 
 ```tsx
 <Link replace />
@@ -268,7 +269,7 @@ This state is inaccessible on the server as it is implemented on top of
 [modes: framework, data, declarative]
 
 Styles can also be applied dynamically via a function that receives
-`NavLinkRenderProps` and returns the styles:
+[`NavLinkRenderProps`](https://api.reactrouter.com/v7/types/react_router.NavLinkRenderProps.html) and returns the styles:
 
 ```tsx
 <NavLink to="/tasks" style={{ color: "red" }} />

docs/api/components/Navigate.md

@@ -22,11 +22,11 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/co
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.Navigate.html)
 
-A component-based version of [`useNavigate`](../hooks/useNavigate) to use in a [`React.Component
-Class`](https://reactjs.org/docs/react-component.html) where hooks are not
-able to be used.
+A component-based version of [`useNavigate`](../hooks/useNavigate) to use in a
+[`React.Component` class](https://react.dev/reference/react/Component) where
+hooks cannot be used.
 
-It's recommended to avoid using this component in favor of [`useNavigate`](../hooks/useNavigate)
+It's recommended to avoid using this component in favor of [`useNavigate`](../hooks/useNavigate).
 
 ```tsx
 <Navigate to="/tasks" />
@@ -40,19 +40,21 @@ function Navigate({ to, replace, state, relative }: NavigateProps): null
 
 ## Props
 
-### to
+### relative
 
-The path to navigate to. This can be a string or an object
+How to interpret relative routing in the `to` prop.
+See [`RelativeRoutingType`](https://api.reactrouter.com/v7/types/react_router.RelativeRoutingType.html).
 
 ### replace
 
-Whether to replace the current entry in the history stack
+Whether to replace the current entry in the [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History)
+stack
 
 ### state
 
-State to pass to the new location to store in [`history.state`](https://developer.mozilla.org/en-US/docs/Web/API/History/state).
+State to pass to the new [`Location`](https://api.reactrouter.com/v7/interfaces/react_router.Location.html) to store in [`history.state`](https://developer.mozilla.org/en-US/docs/Web/API/History/state).
 
-### relative
+### to
 
-How to interpret relative routing in the `to` prop. See [`RelativeRoutingType`](https://api.reactrouter.com/v7/types/react_router.RelativeRoutingType.html).
+The path to navigate to. This can be a string or a [`Path`](https://api.reactrouter.com/v7/interfaces/react_router.Path.html) object
 

docs/api/components/Outlet.md

@@ -22,7 +22,8 @@ https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/co
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.Outlet.html)
 
-Renders the matching child route of a parent route or nothing if no child route matches.
+Renders the matching child route of a parent route or nothing if no child
+route matches.
 
 ```tsx
 import { Outlet } from "react-router";
@@ -47,7 +48,8 @@ function Outlet(props: OutletProps): React.ReactElement | null
 
 ### context
 
-Provides a context value to the element tree below the outlet. Use when the parent route needs to provide values to child routes.
+Provides a context value to the element tree below the outlet. Use when
+the parent route needs to provide values to child routes.
 
 ```tsx
 <Outlet context={myContextValue} />