Skip to content

Commit fe31316

Browse files
remix-run-botynakoo
authored andcommitted
chore: generate markdown docs from jsdocs
1 parent bcf257d commit fe31316

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

docs/api/components/Form.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,17 +62,17 @@ closest route in context.
6262

6363
### discover
6464

65-
Defines the link discovery behavior. See [`DiscoverBehavior`](https://api.reactrouter.com/v7/types/react_router.DiscoverBehavior.html).
65+
Defines the form [lazy route discovery](../../explanation/lazy-route-discovery) behavior.
66+
67+
- **render** — default, discover the route when the form renders
68+
- **none** — don't eagerly discover, only discover if the form is submitted
6669

6770
```tsx
68-
<Link /> // default ("render")
69-
<Link discover="render" />
70-
<Link discover="none" />
71+
<Form /> // default ("render")
72+
<Form discover="render" />
73+
<Form discover="none" />
7174
```
7275

73-
- **render** — default, discover the route when the link renders
74-
- **none** — don't eagerly discover, only discover if the link is clicked
75-
7676
### encType
7777

7878
The encoding type to use for the form submission.

docs/api/components/Link.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,17 @@ import { Link } from "react-router";
4545

4646
[modes: framework]
4747

48-
Defines the link discovery behavior
48+
Defines the link [lazy route discovery](../../explanation/lazy-route-discovery) behavior.
49+
50+
- **render** — default, discover the route when the link renders
51+
- **none** — don't eagerly discover, only discover if the link is clicked
4952

5053
```tsx
5154
<Link /> // default ("render")
5255
<Link discover="render" />
5356
<Link discover="none" />
5457
```
5558

56-
- **render** — default, discover the route when the link renders
57-
- **none** — don't eagerly discover, only discover if the link is clicked
58-
5959
### prefetch
6060

6161
[modes: framework]

docs/api/components/NavLink.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,17 +109,17 @@ returns the `className`:
109109

110110
[modes: framework]
111111

112-
Defines the link discovery behavior
112+
Defines the link [lazy route discovery](../../explanation/lazy-route-discovery) behavior.
113+
114+
- **render** — default, discover the route when the link renders
115+
- **none** — don't eagerly discover, only discover if the link is clicked
113116

114117
```tsx
115118
<Link /> // default ("render")
116119
<Link discover="render" />
117120
<Link discover="none" />
118121
```
119122

120-
- **render** — default, discover the route when the link renders
121-
- **none** — don't eagerly discover, only discover if the link is clicked
122-
123123
### end
124124

125125
[modes: framework, data, declarative]

0 commit comments

Comments
 (0)