Skip to content

Commit 3c06ff9

Browse files
committed
chore: generate markdown docs from jsdocs
1 parent 7928d3d commit 3c06ff9

File tree

3 files changed

+8
-10
lines changed

3 files changed

+8
-10
lines changed

docs/api/components/Await.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Used to render promise values with automatic error handling.
2929
```tsx
3030
import { Await, useLoaderData } from "react-router";
3131

32-
export async function loader() {
32+
export function loader() {
3333
// not awaited
3434
const reviews = getReviews();
3535
// awaited (blocks the transition)

docs/api/data-routers/RouterProvider.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: RouterProvider
55
# RouterProvider
66

77
<!--
8-
⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
8+
⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
99
1010
Thank you for helping improve our documentation!
1111
@@ -32,17 +32,14 @@ import { createRoot } from "react-dom/client";
3232

3333
const router = createBrowserRouter(routes);
3434
createRoot(document.getElementById("root")).render(
35-
<RouterProvider router={router} />,
35+
<RouterProvider router={router} />
3636
);
3737
```
3838

3939
## Signature
4040

4141
```tsx
42-
function RouterProvider({
43-
router,
44-
flushSync: reactDomFlushSyncImpl,
45-
}: RouterProviderProps): React.ReactElement;
42+
function RouterProvider({ router, flushSync: reactDomFlushSyncImpl, }: RouterProviderProps): React.ReactElement
4643
```
4744

4845
## Props
@@ -57,7 +54,7 @@ The [`ReactDOM.flushSync`](https://react.dev/reference/react-dom/flushSync)
5754
implementation to use for flushing updates.
5855

5956
You usually don't have to worry about this:
60-
6157
- The `RouterProvider` exported from `react-router/dom` handles this internally for you
6258
- If you are rendering in a non-DOM environment, you can import
6359
`RouterProvider` from `react-router` and ignore this prop
60+

docs/api/hooks/useLocation.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: useLocation
55
# useLocation
66

77
<!--
8-
⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
8+
⚠️ ⚠️ IMPORTANT ⚠️ ⚠️
99
1010
Thank you for helping improve our documentation!
1111
@@ -45,9 +45,10 @@ function SomeComponent() {
4545
## Signature
4646

4747
```tsx
48-
function useLocation(): Location;
48+
function useLocation(): Location
4949
```
5050

5151
## Returns
5252

5353
The current location object
54+

0 commit comments

Comments
 (0)