Skip to content

Commit c0ce280

Browse files
committed
Improve docs navigation
1 parent a6eb526 commit c0ce280

19 files changed

Lines changed: 113 additions & 332 deletions

File tree

docs/README.md

Lines changed: 0 additions & 132 deletions
This file was deleted.

docs/client/loader-container/loader-container/-internal-.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
---
22
layout: default
3-
title: internal
3+
title: Internal
4+
nav_order: 5
45
---
56

6-
[React18 Loaders](../../../modules.md) / [client/loader-container/loader-container](README.md) / \<internal\>
7+
[React18 Loaders](../../../modules.md) / [client/loader-container/loader-container](index.md) / \<internal\>
78

89
# \<internal\>
910

1011
## Interfaces
1112

1213
### LoaderContainerProps
1314

14-
Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/react18-tools/turborepo-template/blob/ffafbfe4161bc7437e2bb0fd5ea796c2ca7be5ab/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/a6eb526e5f23854bec6388e58fbb1d6429b3a592/lib/src/client/loader-container/loader-container.tsx#L5)
1516

1617
#### Extends
1718

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

2425
> `optional` **children**: `ReactNode`
2526
26-
Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/react18-tools/turborepo-template/blob/ffafbfe4161bc7437e2bb0fd5ea796c2ca7be5ab/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/a6eb526e5f23854bec6388e58fbb1d6429b3a592/lib/src/client/loader-container/loader-container.tsx#L6)
2728

2829
###### Overrides
2930

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

3435
> `optional` **loading**: `boolean`
3536
36-
Defined in: [client/loader-container/loader-container.tsx:7](https://github.com/react18-tools/turborepo-template/blob/ffafbfe4161bc7437e2bb0fd5ea796c2ca7be5ab/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/a6eb526e5f23854bec6388e58fbb1d6429b3a592/lib/src/client/loader-container/loader-container.tsx#L7)

docs/client/loader-container/loader-container/README.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

docs/client/loader-container/loader-container/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
layout: default
3-
title: Loader container
3+
title: Loader Container
4+
nav_order: 4
45
---
56

67
[React18 Loaders](../../../modules.md) / client/loader-container/loader-container
@@ -17,7 +18,7 @@ title: Loader container
1718

1819
> **LoaderContainer**(`__namedParameters`): `Element`
1920
20-
Defined in: [client/loader-container/loader-container.tsx:14](https://github.com/react18-tools/turborepo-template/blob/ffafbfe4161bc7437e2bb0fd5ea796c2ca7be5ab/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/a6eb526e5f23854bec6388e58fbb1d6429b3a592/lib/src/client/loader-container/loader-container.tsx#L14)
2122

2223
# LoaderContainer
2324

docs/constants.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
layout: default
33
title: Constants
4+
nav_order: 2
45
---
56

67
[React18 Loaders](modules.md) / constants
@@ -13,6 +14,6 @@ title: Constants
1314

1415
> `const` **LOADER_RGS_KEY**: `"r18-loaders"` = `"r18-loaders"`
1516
16-
Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/ffafbfe4161bc7437e2bb0fd5ea796c2ca7be5ab/lib/src/constants.ts#L3)
17+
Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/a6eb526e5f23854bec6388e58fbb1d6429b3a592/lib/src/constants.ts#L3)
1718

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

docs/hooks/use-loader.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
layout: default
3-
title: Use loader
3+
title: Use Loader
4+
nav_order: 6
45
---
56

67
[React18 Loaders](../modules.md) / hooks/use-loader
@@ -13,7 +14,7 @@ title: Use loader
1314

1415
> **useLoader**(): `object`
1516
16-
Defined in: [hooks/use-loader.ts:8](https://github.com/react18-tools/turborepo-template/blob/ffafbfe4161bc7437e2bb0fd5ea796c2ca7be5ab/lib/src/hooks/use-loader.ts#L8)
17+
Defined in: [hooks/use-loader.ts:8](https://github.com/react18-tools/turborepo-template/blob/a6eb526e5f23854bec6388e58fbb1d6429b3a592/lib/src/hooks/use-loader.ts#L8)
1718

1819
#### Returns
1920

docs/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
layout: default
3-
title: Home
3+
title: Docs
4+
nav_order: 1
45
---
56

67
# React18 Loaders <img src="https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png" style="height: 40px"/>

docs/modules.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
---
22
layout: default
33
title: Modules
4+
nav_order: 3
45
---
56

67
# React18 Loaders
78

89
## Modules
910

10-
- [client/loader-container/loader-container](client/loader-container/loader-container/README.md)
11+
- [client/loader-container/loader-container](client/loader-container/loader-container/index.md)
1112
- [constants](constants.md)
1213
- [hooks/use-loader](hooks/use-loader.md)
1314
- [server/bars/bars1/bars1](server/bars/bars1/bars1.md)
1415
- [server/bars/bars2/bars2](server/bars/bars2/bars2.md)
15-
- [server/common/base/base](server/common/base/base/README.md)
16+
- [server/common/base/base](server/common/base/base/index.md)
1617
- [server/dots/dots1/dots1](server/dots/dots1/dots1.md)
17-
- [server/dots/dots2/dots2](server/dots/dots2/dots2/README.md)
18+
- [server/dots/dots2/dots2](server/dots/dots2/dots2/index.md)

docs/server/bars/bars1/bars1.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
layout: default
33
title: Bars1
4+
nav_order: 7
45
---
56

67
[React18 Loaders](../../../modules.md) / server/bars/bars1/bars1
@@ -13,15 +14,15 @@ title: Bars1
1314

1415
> **Bars1**(`props`): `Element`
1516
16-
Defined in: [server/bars/bars1/bars1.tsx:10](https://github.com/react18-tools/turborepo-template/blob/ffafbfe4161bc7437e2bb0fd5ea796c2ca7be5ab/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/a6eb526e5f23854bec6388e58fbb1d6429b3a592/lib/src/server/bars/bars1/bars1.tsx#L10)
1718

1819
A simple loader with 3 dots.
1920

2021
#### Parameters
2122

2223
##### props
2324

24-
[`BaseProps`](../../common/base/base/README.md#baseprops)
25+
[`BaseProps`](../../common/base/base/index.md#baseprops)
2526

2627
#### Returns
2728

docs/server/bars/bars2/bars2.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
layout: default
33
title: Bars2
4+
nav_order: 8
45
---
56

67
[React18 Loaders](../../../modules.md) / server/bars/bars2/bars2
@@ -13,15 +14,15 @@ title: Bars2
1314

1415
> **Bars2**(`props`): `Element`
1516
16-
Defined in: [server/bars/bars2/bars2.tsx:10](https://github.com/react18-tools/turborepo-template/blob/ffafbfe4161bc7437e2bb0fd5ea796c2ca7be5ab/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/a6eb526e5f23854bec6388e58fbb1d6429b3a592/lib/src/server/bars/bars2/bars2.tsx#L10)
1718

1819
A simple loader with 3 dots.
1920

2021
#### Parameters
2122

2223
##### props
2324

24-
[`BaseProps`](../../common/base/base/README.md#baseprops)
25+
[`BaseProps`](../../common/base/base/index.md#baseprops)
2526

2627
#### Returns
2728

0 commit comments

Comments
 (0)