chore: generate markdown docs from jsdocs

remix-run-bot · remix-run-bot · commit a04f9d09b0f3 · 2025-07-15T21:34:47.000Z
diff --git a/docs/api/components/Await.md b/docs/api/components/Await.md
@@ -13,7 +13,7 @@ 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/components.tsx#L1264
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/components.tsx
 -->
 
 [MODES: framework, data]
diff --git a/docs/api/components/Form.md b/docs/api/components/Form.md
@@ -13,7 +13,7 @@ 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/lib.tsx#L1210
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/lib.tsx
 -->
 
 [MODES: framework, data]
diff --git a/docs/api/components/Link.md b/docs/api/components/Link.md
@@ -13,7 +13,7 @@ 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/lib.tsx#L641
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/lib.tsx
 -->
 
 [MODES: framework, data, declarative]
diff --git a/docs/api/components/NavLink.md b/docs/api/components/NavLink.md
@@ -13,7 +13,7 @@ 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/lib.tsx#L922
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/lib.tsx
 -->
 
 [MODES: framework, data, declarative]
diff --git a/docs/api/components/Navigate.md b/docs/api/components/Navigate.md
@@ -13,7 +13,7 @@ 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/components.tsx#L645
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/components.tsx
 -->
 
 [MODES: framework, data, declarative]
diff --git a/docs/api/components/Outlet.md b/docs/api/components/Outlet.md
@@ -13,7 +13,7 @@ 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/components.tsx#L724
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/components.tsx
 -->
 
 [MODES: framework, data, declarative]
diff --git a/docs/api/components/Route.md b/docs/api/components/Route.md
@@ -13,7 +13,7 @@ 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/components.tsx#L920
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/components.tsx
 -->
 
 [MODES: framework, data, declarative]
diff --git a/docs/api/components/Routes.md b/docs/api/components/Routes.md
@@ -13,7 +13,7 @@ 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/components.tsx#L1127
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/components.tsx
 -->
 
 [MODES: framework, data, declarative]
diff --git a/docs/api/components/ScrollRestoration.md b/docs/api/components/ScrollRestoration.md
@@ -13,7 +13,7 @@ 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/lib.tsx#L1342
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/lib.tsx
 -->
 
 [MODES: framework, data]
diff --git a/docs/api/data-routers/RouterProvider.md b/docs/api/data-routers/RouterProvider.md
@@ -13,7 +13,7 @@ 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/components.tsx#L263
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/components.tsx
 -->
 
 [MODES: data]
diff --git a/docs/api/data-routers/createBrowserRouter.md b/docs/api/data-routers/createBrowserRouter.md
@@ -13,7 +13,7 @@ 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/lib.tsx#L168
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/lib.tsx
 -->
 
 [MODES: data]
diff --git a/docs/api/data-routers/createHashRouter.md b/docs/api/data-routers/createHashRouter.md
@@ -13,7 +13,7 @@ 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/lib.tsx#L205
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/lib.tsx
 -->
 
 [MODES: data]
diff --git a/docs/api/data-routers/createMemoryRouter.md b/docs/api/data-routers/createMemoryRouter.md
@@ -13,7 +13,7 @@ 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/components.tsx#L178
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/components.tsx
 -->
 
 [MODES: data]
diff --git a/docs/api/declarative-routers/BrowserRouter.md b/docs/api/declarative-routers/BrowserRouter.md
@@ -13,7 +13,7 @@ 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/lib.tsx#L315
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/lib.tsx
 -->
 
 [MODES: declarative]
diff --git a/docs/api/declarative-routers/HashRouter.md b/docs/api/declarative-routers/HashRouter.md
@@ -13,7 +13,7 @@ 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/lib.tsx#L371
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/lib.tsx
 -->
 
 [MODES: declarative]
diff --git a/docs/api/declarative-routers/HistoryRouter.md b/docs/api/declarative-routers/HistoryRouter.md
@@ -14,7 +14,7 @@ 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/lib.tsx#L424
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/lib.tsx
 -->
 
 [MODES: declarative]
diff --git a/docs/api/declarative-routers/MemoryRouter.md b/docs/api/declarative-routers/MemoryRouter.md
@@ -13,7 +13,7 @@ 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/components.tsx#L570
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/components.tsx
 -->
 
 [MODES: declarative]
diff --git a/docs/api/declarative-routers/Router.md b/docs/api/declarative-routers/Router.md
@@ -13,7 +13,7 @@ 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/components.tsx#L1018
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/components.tsx
 -->
 
 [MODES: declarative]
diff --git a/docs/api/hooks/useActionData.md b/docs/api/hooks/useActionData.md
@@ -13,7 +13,7 @@ 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/hooks.tsx#L1328
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx
 -->
 
 [MODES: framework, data]
diff --git a/docs/api/hooks/useAsyncError.md b/docs/api/hooks/useAsyncError.md
@@ -13,7 +13,7 @@ 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/hooks.tsx#L1423
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx
 -->
 
 [MODES: framework, data]
diff --git a/docs/api/hooks/useAsyncValue.md b/docs/api/hooks/useAsyncValue.md
@@ -13,7 +13,7 @@ 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/hooks.tsx#L1398
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx
 -->
 
 [MODES: framework, data]
diff --git a/docs/api/hooks/useBeforeUnload.md b/docs/api/hooks/useBeforeUnload.md
@@ -13,7 +13,7 @@ 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/lib.tsx#L2418
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/lib.tsx
 -->
 
 [MODES: framework, data, declarative]
diff --git a/docs/api/hooks/useBlocker.md b/docs/api/hooks/useBlocker.md
@@ -13,7 +13,7 @@ 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/hooks.tsx#L1455
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx
 -->
 
 [MODES: framework, data]
diff --git a/docs/api/hooks/useFetcher.md b/docs/api/hooks/useFetcher.md
@@ -13,7 +13,7 @@ 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/lib.tsx#L2076
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/lib.tsx
 -->
 
 [MODES: framework, data]
diff --git a/docs/api/hooks/useFetchers.md b/docs/api/hooks/useFetchers.md
@@ -13,7 +13,7 @@ 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/lib.tsx#L2216
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/lib.tsx
 -->
 
 [MODES: framework, data]
diff --git a/docs/api/hooks/useFormAction.md b/docs/api/hooks/useFormAction.md
@@ -13,7 +13,7 @@ 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/lib.tsx#L1895
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/lib.tsx
 -->
 
 [MODES: framework, data]
diff --git a/docs/api/hooks/useHref.md b/docs/api/hooks/useHref.md
@@ -13,7 +13,7 @@ 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/hooks.tsx#L55
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx
 -->
 
 [MODES: framework, data, declarative]
diff --git a/docs/api/hooks/useInRouterContext.md b/docs/api/hooks/useInRouterContext.md
@@ -13,7 +13,7 @@ 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/hooks.tsx#L102
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx
 -->
 
 [MODES: framework, data]
diff --git a/docs/api/hooks/useLinkClickHandler.md b/docs/api/hooks/useLinkClickHandler.md
@@ -13,7 +13,7 @@ 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/lib.tsx#L1487
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/lib.tsx
 -->
 
 [MODES: framework, data, declarative]
diff --git a/docs/api/hooks/useLoaderData.md b/docs/api/hooks/useLoaderData.md
@@ -13,7 +13,7 @@ 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/hooks.tsx#L1262
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx
 -->
 
 [MODES: framework, data]
diff --git a/docs/api/hooks/useLocation.md b/docs/api/hooks/useLocation.md
@@ -13,7 +13,7 @@ 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/hooks.tsx#L116
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx
 -->
 
 [MODES: framework, data, declarative]
diff --git a/docs/api/hooks/useMatch.md b/docs/api/hooks/useMatch.md
@@ -13,7 +13,7 @@ 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/hooks.tsx#L163
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx
 -->
 
 [MODES: framework, data, declarative]
diff --git a/docs/api/hooks/useMatches.md b/docs/api/hooks/useMatches.md
@@ -13,7 +13,7 @@ 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/hooks.tsx#L1242
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx
 -->
 
 [MODES: framework, data]
diff --git a/docs/api/hooks/useNavigate.md b/docs/api/hooks/useNavigate.md
@@ -13,7 +13,7 @@ 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/hooks.tsx#L216
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx
 -->
 
 [MODES: framework, data, declarative]
diff --git a/docs/api/hooks/useNavigation.md b/docs/api/hooks/useNavigation.md
@@ -13,7 +13,7 @@ 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/hooks.tsx#L1174
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx
 -->
 
 [MODES: framework, data]
diff --git a/docs/api/hooks/useNavigationType.md b/docs/api/hooks/useNavigationType.md
@@ -13,7 +13,7 @@ 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/hooks.tsx#L151
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx
 -->
 
 [MODES: framework, data, declarative]
diff --git a/docs/api/hooks/useOutlet.md b/docs/api/hooks/useOutlet.md
@@ -13,7 +13,7 @@ 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/hooks.tsx#L402
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx
 -->
 
 [MODES: framework, data, declarative]
diff --git a/docs/api/hooks/useOutletContext.md b/docs/api/hooks/useOutletContext.md
@@ -13,7 +13,7 @@ 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/hooks.tsx#L391
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx
 -->
 
 [MODES: framework, data, declarative]
diff --git a/docs/api/hooks/useParams.md b/docs/api/hooks/useParams.md
@@ -13,7 +13,7 @@ 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/hooks.tsx#L421
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx
 -->
 
 [MODES: framework, data, declarative]
diff --git a/docs/api/hooks/usePrompt.md b/docs/api/hooks/usePrompt.md
@@ -14,7 +14,7 @@ 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/lib.tsx#L2465
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom/lib.tsx
 -->
 
 [MODES: framework, data]
diff --git a/docs/api/hooks/useResolvedPath.md b/docs/api/hooks/useResolvedPath.md
@@ -13,7 +13,7 @@ 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/hooks.tsx#L532
+https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx
 -->
 
 [MODES: framework, data, declarative]
diff --git a/docs/api/hooks/useRevalidator.md b/docs/api/hooks/useRevalidator.md
diff --git a/docs/api/hooks/useRouteError.md b/docs/api/hooks/useRouteError.md
diff --git a/docs/api/hooks/useRouteLoaderData.md b/docs/api/hooks/useRouteLoaderData.md
diff --git a/docs/api/hooks/useRoutes.md b/docs/api/hooks/useRoutes.md
diff --git a/docs/api/hooks/useSearchParams.md b/docs/api/hooks/useSearchParams.md
diff --git a/docs/api/hooks/useSubmit.md b/docs/api/hooks/useSubmit.md
diff --git a/docs/api/hooks/useViewTransitionState.md b/docs/api/hooks/useViewTransitionState.md
diff --git a/docs/api/utils/createRoutesFromElements.md b/docs/api/utils/createRoutesFromElements.md
diff --git a/docs/api/utils/renderMatches.md b/docs/api/utils/renderMatches.md
