chore: generate markdown docs from jsdocs

Author: remix-run-bot

docs/api/hooks/useBlocker.md

@@ -4,68 +4,71 @@ title: useBlocker
 
 # useBlocker
 
+<!--
+⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ 
+
+Hey! Thank you for helping improve our documentation!
+
+This file is auto-generated from the JSDoc comments in the source
+code, so please find the definition of this API and edit the JSDoc
+comments accordingly and this file will be re-generated once those
+changes are merged.
+-->
+
 [MODES: framework, data]
 
 ## Summary
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.useBlocker.html)
 
-Allow the application to block navigations within the SPA and present the user a confirmation dialog to confirm the navigation. Mostly used to avoid using half-filled form data. This does not handle hard-reloads or cross-origin navigations.
-
-## Signature
+Allow the application to block navigations within the SPA and present the
+user a confirmation dialog to confirm the navigation.  Mostly used to avoid
+using half-filled form data.  This does not handle hard-reloads or
+cross-origin navigations.
+
+The Blocker object returned by the hook has the following properties:
+
+- **`state`**
+  - `unblocked` - the blocker is idle and has not prevented any navigation
+  - `blocked` - the blocker has prevented a navigation
+  - `proceeding` - the blocker is proceeding through from a blocked navigation
+- **`location`**
+  - When in a `blocked` state, this represents the [`Location`](https://api.reactrouter.com/v7/interfaces/react_router.Location.html) to which we
+    blocked a navigation. When in a `proceeding` state, this is the location
+    being navigated to after a `blocker.proceed()` call.
+- **`proceed()`**
+  - When in a `blocked` state, you may call `blocker.proceed()` to proceed to the
+    blocked location.
+- **`reset()`**
+  - When in a `blocked` state, you may call `blocker.reset()` to return the blocker
+    back to an `unblocked` state and leave the user at the current location.
 
 ```tsx
-useBlocker(shouldBlock: boolean | BlockerFunction): Blocker
-```
-
-## Params
-
-### shouldBlock
-
-[modes: framework, data]
-
-**boolean**
-
-Whether or not the navigation should be blocked. If `true`, the blocker will prevent the navigation. If `false`, the blocker will not prevent the navigation.
-
-[**BlockerFunction**](https://api.reactrouter.com/v7/types/react_router.BlockerFunction.html)
+// Boolean version
+const blocker = useBlocker(value !== "");
 
-A function that returns a boolean indicating whether the navigation should be blocked.
-
-```tsx
+// Function version
 const blocker = useBlocker(
   ({ currentLocation, nextLocation, historyAction }) =>
     value !== "" &&
     currentLocation.pathname !== nextLocation.pathname
 );
 ```
 
-## Blocker
-
-The [Blocker](https://api.reactrouter.com/v7/types/react_router.Blocker.html) object returned by the hook. It has the following properties:
-
-### `state`
-
-- `unblocked` - the blocker is idle and has not prevented any navigation
-- `blocked` - the blocker has prevented a navigation
-- `proceeding` - the blocker is proceeding through from a blocked navigation
-
-### `location`
-
-When in a `blocked` state, this represents the [`Location`](https://api.reactrouter.com/v7/interfaces/react_router.Location.html) to which we blocked a navigation. When in a `proceeding` state, this is the location being navigated to after a `blocker.proceed()` call.
+## Signature
 
-### `proceed()`
+```tsx
+useBlocker(shouldBlock: boolean | BlockerFunction): Blocker
+```
 
-When in a `blocked` state, you may call `blocker.proceed()` to proceed to the blocked location.
+## Params
 
-### `reset()`
+### shouldBlock
 
-When in a `blocked` state, you may call `blocker.reset()` to return the blocker back to an `unblocked` state and leave the user at the current location.
+Either a boolean or a function returning a boolean which indicates whether the navigation should be blocked. The function format receives a single object parameter containing the `currentLocation`, `nextLocation`, and `historyAction` of the potential navigation.
 
 ## Examples
 
-### Basic
-
 ```tsx
 import { useCallback, useState } from "react";
 import { BlockerFunction, useBlocker } from "react-router";
@@ -128,3 +131,4 @@ export function ImportantForm() {
   );
 }
 ```
+