Skip to content

Commit f1923d4

Browse files
committed
test improved docs
1 parent 9ed5b33 commit f1923d4

File tree

11 files changed

+25
-26
lines changed

11 files changed

+25
-26
lines changed

docs/constants.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ nav_order: 2
1313

1414
> `const` **LOADER_RGS_KEY**: `"r18-loaders"` = `"r18-loaders"`
1515
16-
Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/constants.ts#L3)
16+
Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/constants.ts#L3)
1717

1818
const uuid = () =\> (Date.now() \* Math.random()).toString(16).slice(2, 8);

docs/loader-container/-internal-.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ nav_order: 6
1212

1313
### LoaderContainerProps
1414

15-
Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/client/loader-container/loader-container.tsx#L5)
15+
Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/client/loader-container/loader-container.tsx#L5)
1616

1717
#### Extends
1818

@@ -24,7 +24,7 @@ Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/
2424

2525
> `optional` **children**: `ReactNode`
2626
27-
Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/client/loader-container/loader-container.tsx#L6)
27+
Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/client/loader-container/loader-container.tsx#L6)
2828

2929
###### Overrides
3030

@@ -34,4 +34,4 @@ Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/
3434

3535
> `optional` **loading**: `boolean`
3636
37-
Defined in: [client/loader-container/loader-container.tsx:7](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/client/loader-container/loader-container.tsx#L7)
37+
Defined in: [client/loader-container/loader-container.tsx:7](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/client/loader-container/loader-container.tsx#L7)

docs/loader-container/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
layout: default
33
title: Loader Container
4-
parent: Loader Container
54
nav_order: 5
65
has_children: true
76
---
@@ -19,7 +18,7 @@ has_children: true
1918

2019
> **LoaderContainer**(`__namedParameters`): `Element`
2120
22-
Defined in: [client/loader-container/loader-container.tsx:14](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/client/loader-container/loader-container.tsx#L14)
21+
Defined in: [client/loader-container/loader-container.tsx:14](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/client/loader-container/loader-container.tsx#L14)
2322

2423
# LoaderContainer
2524

docs/server/bars/bars1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ nav_order: 11
1414

1515
> **Bars1**(`props`): `Element`
1616
17-
Defined in: [server/bars/bars1/bars1.tsx:10](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/server/bars/bars1/bars1.tsx#L10)
17+
Defined in: [server/bars/bars1/bars1.tsx:10](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/server/bars/bars1/bars1.tsx#L10)
1818

1919
A simple loader with 3 dots.
2020

docs/server/bars/bars2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ nav_order: 12
1414

1515
> **Bars2**(`props`): `Element`
1616
17-
Defined in: [server/bars/bars2/bars2.tsx:10](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/server/bars/bars2/bars2.tsx#L10)
17+
Defined in: [server/bars/bars2/bars2.tsx:10](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/server/bars/bars2/bars2.tsx#L10)
1818

1919
A simple loader with 3 dots.
2020

docs/server/base/-internal-.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ nav_order: 15
1212

1313
### OtherProps
1414

15-
Defined in: [server/common/base/base.tsx:14](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/server/common/base/base.tsx#L14)
15+
Defined in: [server/common/base/base.tsx:14](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/server/common/base/base.tsx#L14)
1616

1717
Other props - loaderClass is included here as we will extend BaseProps for other loaders
1818

@@ -22,12 +22,12 @@ Other props - loaderClass is included here as we will extend BaseProps for other
2222

2323
> `optional` **dotRadius**: `string` \| `number`
2424
25-
Defined in: [server/common/base/base.tsx:17](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/server/common/base/base.tsx#L17)
25+
Defined in: [server/common/base/base.tsx:17](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/server/common/base/base.tsx#L17)
2626

2727
##### loaderClass
2828

2929
> **loaderClass**: `string`
3030
31-
Defined in: [server/common/base/base.tsx:16](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/server/common/base/base.tsx#L16)
31+
Defined in: [server/common/base/base.tsx:16](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/server/common/base/base.tsx#L16)
3232

3333
Loader class name

docs/server/base/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: Base
4-
parent: Base
4+
parent: Server
55
nav_order: 14
66
has_children: true
77
---
@@ -17,7 +17,7 @@ has_children: true
1717

1818
### BaseProps
1919

20-
Defined in: [server/common/base/base.tsx:4](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/server/common/base/base.tsx#L4)
20+
Defined in: [server/common/base/base.tsx:4](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/server/common/base/base.tsx#L4)
2121

2222
Interface declaring the common properties of the loaders
2323

@@ -35,7 +35,7 @@ Interface declaring the common properties of the loaders
3535

3636
> `optional` **color**: `string`
3737
38-
Defined in: [server/common/base/base.tsx:10](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/server/common/base/base.tsx#L10)
38+
Defined in: [server/common/base/base.tsx:10](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/server/common/base/base.tsx#L10)
3939

4040
Color of the dots - CSS compatible color
4141

@@ -47,7 +47,7 @@ Color of the dots - CSS compatible color
4747

4848
> `optional` **height**: `string` \| `number`
4949
50-
Defined in: [server/common/base/base.tsx:8](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/server/common/base/base.tsx#L8)
50+
Defined in: [server/common/base/base.tsx:8](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/server/common/base/base.tsx#L8)
5151

5252
height of the loader element in pixels or a string with a length unit.
5353

@@ -59,7 +59,7 @@ height of the loader element in pixels or a string with a length unit.
5959

6060
> `optional` **width**: `string` \| `number`
6161
62-
Defined in: [server/common/base/base.tsx:6](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/server/common/base/base.tsx#L6)
62+
Defined in: [server/common/base/base.tsx:6](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/server/common/base/base.tsx#L6)
6363

6464
width of the loader element in pixels or a string with a length unit.
6565

@@ -73,7 +73,7 @@ width of the loader element in pixels or a string with a length unit.
7373

7474
> **Base**(`__namedParameters`): `Element`
7575
76-
Defined in: [server/common/base/base.tsx:25](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/server/common/base/base.tsx#L25)
76+
Defined in: [server/common/base/base.tsx:25](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/server/common/base/base.tsx#L25)
7777

7878
Base component to avoid code duplication
7979

docs/server/dots/dots1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ nav_order: 18
1414

1515
> **Dots1**(`props`): `Element`
1616
17-
Defined in: [server/dots/dots1/dots1.tsx:10](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/server/dots/dots1/dots1.tsx#L10)
17+
Defined in: [server/dots/dots1/dots1.tsx:10](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/server/dots/dots1/dots1.tsx#L10)
1818

1919
A simple loader with 3 dots.
2020

docs/server/dots/dots2/-internal-.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ nav_order: 21
1212

1313
### Dots2Props
1414

15-
Defined in: [server/dots/dots2/dots2.tsx:4](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/server/dots/dots2/dots2.tsx#L4)
15+
Defined in: [server/dots/dots2/dots2.tsx:4](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/server/dots/dots2/dots2.tsx#L4)
1616

1717
Interface declaring the common properties of the loaders
1818

@@ -26,7 +26,7 @@ Interface declaring the common properties of the loaders
2626

2727
> `optional` **color**: `string`
2828
29-
Defined in: [server/common/base/base.tsx:10](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/server/common/base/base.tsx#L10)
29+
Defined in: [server/common/base/base.tsx:10](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/server/common/base/base.tsx#L10)
3030

3131
Color of the dots - CSS compatible color
3232

@@ -38,15 +38,15 @@ Color of the dots - CSS compatible color
3838

3939
> `optional` **dotRadius**: `string` \| `number`
4040
41-
Defined in: [server/dots/dots2/dots2.tsx:6](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/server/dots/dots2/dots2.tsx#L6)
41+
Defined in: [server/dots/dots2/dots2.tsx:6](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/server/dots/dots2/dots2.tsx#L6)
4242

4343
Radius of the dots in pixels or a string with a length unit.
4444

4545
##### height?
4646

4747
> `optional` **height**: `string` \| `number`
4848
49-
Defined in: [server/common/base/base.tsx:8](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/server/common/base/base.tsx#L8)
49+
Defined in: [server/common/base/base.tsx:8](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/server/common/base/base.tsx#L8)
5050

5151
height of the loader element in pixels or a string with a length unit.
5252

@@ -58,7 +58,7 @@ height of the loader element in pixels or a string with a length unit.
5858

5959
> `optional` **width**: `string` \| `number`
6060
61-
Defined in: [server/common/base/base.tsx:6](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/server/common/base/base.tsx#L6)
61+
Defined in: [server/common/base/base.tsx:6](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/server/common/base/base.tsx#L6)
6262

6363
width of the loader element in pixels or a string with a length unit.
6464

docs/server/dots/dots2/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: Dots2
4-
parent: Dots2
4+
parent: Dots
55
nav_order: 20
66
has_children: true
77
---
@@ -19,7 +19,7 @@ has_children: true
1919

2020
> **Dots2**(`props`): `Element`
2121
22-
Defined in: [server/dots/dots2/dots2.tsx:15](https://github.com/react18-tools/turborepo-template/blob/7391c92cfd2f29d798499dc97ae86a2f94c80212/lib/src/server/dots/dots2/dots2.tsx#L15)
22+
Defined in: [server/dots/dots2/dots2.tsx:15](https://github.com/react18-tools/turborepo-template/blob/9ed5b3363924f189688b70191d59baca25771534/lib/src/server/dots/dots2/dots2.tsx#L15)
2323

2424
A simple loader with 3 dots.
2525

0 commit comments

Comments
 (0)