chore: generate markdown docs from jsdocs

Author: remix-run-bot

docs/api/data-routers/StaticRouterProvider.md

@@ -4,6 +4,18 @@ title: StaticRouterProvider
 
 # StaticRouterProvider
 
+<!--
+⚠️ ⚠️ 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/server.tsx
+-->
+
 [MODES: data]
 
 ## Summary
@@ -13,28 +25,44 @@ title: StaticRouterProvider
 A Data Router that may not navigate to any other location. This is useful
 on the server where there is no stateful UI.
 
-## Props
+```tsx
+export async function handleRequest(request: Request) {
+  let { query, dataRoutes } = createStaticHandler(routes);
+  let context = await query(request));
 
-### context
+  if (context instanceof Response) {
+    return context;
+  }
 
-[modes: data]
+  let router = createStaticRouter(dataRoutes, context);
+  return new Response(
+    ReactDOMServer.renderToString(<StaticRouterProvider ... />),
+    { headers: { "Content-Type": "text/html" } }
+  );
+}
+```
 
-_No documentation_
+## Signature
 
-### hydrate
+```tsx
+function StaticRouterProvider({ context, router, hydrate = true, nonce, }: StaticRouterProviderProps)
+```
+
+## Props
 
-[modes: data]
+### context
 
-_No documentation_
+The [`StaticHandlerContext`](https://api.reactrouter.com/v7/interfaces/react_router.StaticHandlerContext.html) returned from `staticHandler.query()`
 
-### nonce
+### router
 
-[modes: data]
+The static data router from [`createStaticRouter`](../data-routers/createStaticRouter)
 
-_No documentation_
+### hydrate
 
-### router
+Whether to hydrate the router on the client (default `true`)
+
+### nonce
 
-[modes: data]
+The [`nonce`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/nonce) to use for the hydration `<script>` tag
 
-_No documentation_

docs/api/data-routers/createStaticHandler.md

@@ -0,0 +1,67 @@
+---
+title: createStaticHandler
+---
+
+# createStaticHandler
+
+<!--
+⚠️ ⚠️ 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/server.tsx
+-->
+
+[MODES: data]
+
+## Summary
+
+[Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.createStaticHandler.html)
+
+Create a static handler to perform server-side data loading
+
+```tsx
+export async function handleRequest(request: Request) {
+  let { query, dataRoutes } = createStaticHandler(routes);
+  let context = await query(request));
+
+  if (context instanceof Response) {
+    return context;
+  }
+
+  let router = createStaticRouter(dataRoutes, context);
+  return new Response(
+    ReactDOMServer.renderToString(<StaticRouterProvider ... />),
+    { headers: { "Content-Type": "text/html" } }
+  );
+}
+```
+
+## Signature
+
+```tsx
+function createStaticHandler(routes: RouteObject[], opts?: CreateStaticHandlerOptions)
+```
+
+## Params
+
+### routes
+
+The route objects to create a static handler for
+
+### opts.basename
+
+The base URL for the static handler (default: `/`)
+
+### opts.future
+
+Future flags for the static handler
+
+## Returns
+
+A static handler that can be used to query data for the provided routes
+

docs/api/data-routers/createStaticRouter.md

@@ -4,34 +4,66 @@ title: createStaticRouter
 
 # createStaticRouter
 
+<!--
+⚠️ ⚠️ 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/server.tsx
+-->
+
 [MODES: data]
 
 ## Summary
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.createStaticRouter.html)
 
+Create a static data router for server-side rendering
+
+```tsx
+export async function handleRequest(request: Request) {
+  let { query, dataRoutes } = createStaticHandler(routes);
+  let context = await query(request));
+
+  if (context instanceof Response) {
+    return context;
+  }
+
+  let router = createStaticRouter(dataRoutes, context);
+  return new Response(
+    ReactDOMServer.renderToString(<StaticRouterProvider ... />),
+    { headers: { "Content-Type": "text/html" } }
+  );
+}
+```
+
 ## Signature
 
 ```tsx
-createStaticRouter(routes, context, opts): DataRouter
+function createStaticRouter(routes: RouteObject[], context: StaticHandlerContext, opts: {
+    future?: Partial<FutureConfig>;
+} = {}): DataRouter
 ```
 
 ## Params
 
 ### routes
 
-[modes: data]
-
-_No documentation_
+The route objects to create a static data router for
 
 ### context
 
-[modes: data]
+The static handler context returned from `staticHandler.query()`
+
+### opts.future
 
-_No documentation_
+Future flags for the static data router
 
-### opts
+## Returns
 
-[modes: data]
+A static data router that can be used to render the provided routes
 
-_No documentation_

docs/api/declarative-routers/StaticRouter.md

@@ -4,6 +4,18 @@ title: StaticRouter
 
 # StaticRouter
 
+<!--
+⚠️ ⚠️ 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/server.tsx
+-->
+
 [MODES: declarative]
 
 ## Summary
@@ -13,22 +25,23 @@ title: StaticRouter
 A `<Router>` that may not navigate to any other location. This is useful
 on the server where there is no stateful UI.
 
+## Signature
+
+```tsx
+function StaticRouter({ basename, children, location: locationProp = "/", }: StaticRouterProps)
+```
+
 ## Props
 
 ### basename
 
-[modes: declarative]
-
-_No documentation_
+The base URL for the static router (default: `/`)
 
 ### children
 
-[modes: declarative]
-
-_No documentation_
+The child elements to render inside the static router
 
 ### location
 
-[modes: declarative]
+The location to render the static router at (default: `/`)
 
-_No documentation_