chore: generate markdown docs from jsdocs

remix-run-bot · remix-run-bot · commit 84425b917e0e · 2025-07-16T18:14:49.000Z
diff --git a/docs/api/components/Links.md b/docs/api/components/Links.md
@@ -4,13 +4,27 @@ title: Links
 
 # Links
 
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please edit the JSDoc comments in the file below and this
+file will be re-generated once those changes are merged.
+
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/ssr/components.tsx
+-->
+
 [MODES: framework]
 
 ## Summary
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.Links.html)
 
-Renders all of the `<link>` tags created by route module [`links`](../../start/framework/route-module#links) export. You should render it inside the `<head>` of your document.
+Renders all of the `<link>` tags created by the route module
+[`links`](../../start/framework/route-module#links) export. You should render
+it inside the `<head>` of your document.
 
 ```tsx
 import { Links } from "react-router";
@@ -27,6 +41,9 @@ export default function Root() {
 }
 ```
 
-## Props
+## Signature
+
+```tsx
+function Links(): React.JSX.Element
+```
 
-None
diff --git a/docs/api/components/Meta.md b/docs/api/components/Meta.md
@@ -4,13 +4,27 @@ title: Meta
 
 # Meta
 
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please edit the JSDoc comments in the file below and this
+file will be re-generated once those changes are merged.
+
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/ssr/components.tsx
+-->
+
 [MODES: framework]
 
 ## Summary
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.Meta.html)
 
-Renders all the `<meta>` tags created by route module [`meta`](../../start/framework/route-module#meta) export. You should render it inside the `<head>` of your HTML.
+Renders all the `<meta>` tags created by the route module
+[`meta`](../../start/framework/route-module#meta) exports. You should render
+it inside the `<head>` of your HTML.
 
 ```tsx
 import { Meta } from "react-router";
@@ -26,6 +40,9 @@ export default function Root() {
 }
 ```
 
-## Props
+## Signature
+
+```tsx
+function Meta(): React.JSX.Element
+```
 
-None
diff --git a/docs/api/components/PrefetchPageLinks.md b/docs/api/components/PrefetchPageLinks.md
@@ -4,62 +4,52 @@ title: PrefetchPageLinks
 
 # PrefetchPageLinks
 
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please edit the JSDoc comments in the file below and this
+file will be re-generated once those changes are merged.
+
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/ssr/components.tsx
+-->
+
 [MODES: framework]
 
 ## Summary
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.PrefetchPageLinks.html)
 
-Renders `<link rel=prefetch|modulepreload>` tags for modules and data of another page to enable an instant navigation to that page. `<Link prefetch>` uses this internally, but you can render it to prefetch a page for any other reason.
+Renders `<link rel=prefetch|modulepreload>` tags for modules and data of
+another page to enable an instant navigation to that page.
+[`<Link prefetch>`](../../components/Link#prefetch) uses this internally, but
+you can render it to prefetch a page for any other reason.
+
+For example, you may render one of this as the user types into a search field
+to prefetch search results before they click through to their selection.
 
 ```tsx
 import { PrefetchPageLinks } from "react-router";
 
-<PrefetchPageLinks page="/absolute/path" />;
+<PrefetchPageLinks page="/absolute/path" />
 ```
 
-For example, you may render one of this as the user types into a search field to prefetch search results before they click through to their selection.
-
-## Props
-
-### crossOrigin
-
-[modes: framework]
-
-How the element handles crossorigin requests
-
-### disabled
-
-[modes: framework]
+## Signature
 
-Whether the link is disabled
-
-### hrefLang
-
-[modes: framework]
-
-Language of the linked resource
-
-### integrity
-
-[modes: framework]
-
-Integrity metadata used in Subresource Integrity checks
-
-### media
-
-[modes: framework]
+```tsx
+function PrefetchPageLinks({ page, ...dataLinkProps }: PageLinkDescriptor)
+```
 
-Applicable media: "screen", "print", "(max-width: 764px)"
+## Props
 
 ### page
 
-[modes: framework]
-
-The absolute path of the page to prefetch.
+The absolute path of the page to prefetch, e.g. `/absolute/path`.
 
-### referrerPolicy
+### dataLinkProps
 
-[modes: framework]
+Additional props to pass to the [`<link>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/link)
+tag, such as `crossOrigin`, `integrity`, `rel`, etc.
 
-Referrer policy for fetches initiated by the element
diff --git a/docs/api/components/Scripts.md b/docs/api/components/Scripts.md
@@ -4,13 +4,30 @@ title: Scripts
 
 # Scripts
 
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please edit the JSDoc comments in the file below and this
+file will be re-generated once those changes are merged.
+
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/ssr/components.tsx
+-->
+
 [MODES: framework]
 
 ## Summary
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.Scripts.html)
 
-Renders the client runtime of your app. It should be rendered inside the `<body>` of the document.
+Renders the client runtime of your app. It should be rendered inside the
+`<body>` of the document.
+
+If server rendering, you can omit `<Scripts/>` and the app will work as a
+traditional web app without JavaScript, relying solely on HTML and browser
+behaviors.
 
 ```tsx
 import { Scripts } from "react-router";
@@ -27,17 +44,16 @@ export default function Root() {
 }
 ```
 
-If server rendering, you can omit `<Scripts/>` and the app will work as a traditional web app without JavaScript, relying solely on HTML and browser behaviors.
+## Signature
 
-## Props
-
-### ScriptsProps
+```tsx
+function Scripts(props: ScriptsProps): React.JSX.Element | null
+```
 
-[modes: framework]
+## Props
 
-A couple common attributes:
+### props
 
-- `<Scripts crossOrigin>` for hosting your static assets on a different server than your app.
-- `<Scripts nonce>` to support a [content security policy for scripts](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src) with [nonce-sources](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/Sources#sources) for your `<script>` tags.
+Props for the [`<script>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/script)
+tag, such as `crossOrigin`, `nonce`, etc.
 
-You cannot pass through attributes such as `async`, `defer`, `src`, `type`, `noModule` because they are managed by React Router internally.
diff --git a/docs/api/framework-routers/HydratedRouter.md b/docs/api/framework-routers/HydratedRouter.md
@@ -0,0 +1,38 @@
+---
+title: HydratedRouter
+---
+
+# HydratedRouter
+
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please edit the JSDoc comments in the file below and this
+file will be re-generated once those changes are merged.
+
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom-export/hydrated-router.tsx
+-->
+
+[MODES: framework]
+
+## Summary
+
+Framework-mode router component to be used to to hydrate a router from a
+`ServerRouter`. See [`entry.client.tsx`](../api/framework-conventions/entry.client.tsx).
+
+## Signature
+
+```tsx
+function HydratedRouter(props: HydratedRouterProps)
+```
+
+## Props
+
+### unstable_getContext
+
+Context object to passed through to [`createBrowserRouter`](../data-routers/createBrowserRouter) and made available to `clientLoader`/`clientAction`
+functions
+
diff --git a/docs/api/framework-routers/ServerRouter.md b/docs/api/framework-routers/ServerRouter.md
@@ -0,0 +1,48 @@
+---
+title: ServerRouter
+---
+
+# ServerRouter
+
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please edit the JSDoc comments in the file below and this
+file will be re-generated once those changes are merged.
+
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/ssr/server.tsx
+-->
+
+[MODES: framework]
+
+## Summary
+
+[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.ServerRouter.html)
+
+The server entry point for a React Router app in Framework Mode. This component
+is used to generate the HTML in the response from the server.
+See [`entry.server.tsx`](../api/framework-conventions/entry.server.tsx).
+
+## Signature
+
+```tsx
+function ServerRouter({ context, url, nonce, }: ServerRouterProps): ReactElement
+```
+
+## Props
+
+### context
+
+The entry context containing the manifest, route modules, and other data needed for rendering.
+
+### url
+
+The URL of the request being handled.
+
+### nonce
+
+An optional nonce for Content Security Policy (CSP) compliance, used to allow inline scripts to run safely.
+
