Skip to content

Commit d00080f

Browse files
committed
test improved docs
1 parent 7e25a06 commit d00080f

File tree

25 files changed

+107
-137
lines changed

25 files changed

+107
-137
lines changed

docs/client/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
layout: default
33
title: Client
4+
parent: Home
45
nav_order: 4
56
has_children: true
67
---
7-
88
# Client
9-
10-
- [Loader Container](loader-container/)
9+
- [Loader Container](loader-container/)

docs/client/loader-container/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
layout: default
33
title: Loader Container
4+
parent: Client
45
nav_order: 6
56
has_children: true
67
---
7-
88
# Loader Container
9-
10-
- [Loader Container](loader-container/)
9+
- [Loader Container](loader-container/)

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ title: Internal
44
parent: Loader Container
55
nav_order: 10
66
---
7-
87
[React18 Loaders](../../../index.md) / [client/loader-container/loader-container](index.md) / \<internal\>
98

109
# \<internal\>
@@ -13,7 +12,7 @@ nav_order: 10
1312

1413
### LoaderContainerProps
1514

16-
Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/react18-tools/turborepo-template/blob/2635c856ec31df0d27eb77876e3eb8707c5d4b76/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/7e25a06c2e585bd4aae84dc3767c674dbbee497c/lib/src/client/loader-container/loader-container.tsx#L5)
1716

1817
#### Extends
1918

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

2625
> `optional` **children**: `ReactNode`
2726
28-
Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/react18-tools/turborepo-template/blob/2635c856ec31df0d27eb77876e3eb8707c5d4b76/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/7e25a06c2e585bd4aae84dc3767c674dbbee497c/lib/src/client/loader-container/loader-container.tsx#L6)
2928

3029
###### Overrides
3130

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

3635
> `optional` **loading**: `boolean`
3736
38-
Defined in: [client/loader-container/loader-container.tsx:7](https://github.com/react18-tools/turborepo-template/blob/2635c856ec31df0d27eb77876e3eb8707c5d4b76/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/7e25a06c2e585bd4aae84dc3767c674dbbee497c/lib/src/client/loader-container/loader-container.tsx#L7)

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ title: Loader Container
44
nav_order: 9
55
has_children: true
66
---
7-
87
[React18 Loaders](../../../index.md) / client/loader-container/loader-container
98

109
# client/loader-container/loader-container
@@ -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/2635c856ec31df0d27eb77876e3eb8707c5d4b76/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/7e25a06c2e585bd4aae84dc3767c674dbbee497c/lib/src/client/loader-container/loader-container.tsx#L14)
2322

2423
# LoaderContainer
2524

docs/constants.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
---
22
layout: default
33
title: Constants
4-
parent: Docs
54
nav_order: 3
65
---
7-
86
[React18 Loaders](index.md) / constants
97

108
# constants
@@ -15,6 +13,6 @@ nav_order: 3
1513

1614
> `const` **LOADER_RGS_KEY**: `"r18-loaders"` = `"r18-loaders"`
1715
18-
Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/2635c856ec31df0d27eb77876e3eb8707c5d4b76/lib/src/constants.ts#L3)
16+
Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/7e25a06c2e585bd4aae84dc3767c674dbbee497c/lib/src/constants.ts#L3)
1917

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

docs/hooks/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
layout: default
33
title: Hooks
4+
parent: Home
45
nav_order: 11
56
has_children: true
67
---
7-
88
# Hooks
9-
10-
- [Use Loader](use-loader.md)
9+
- [Use Loader](use-loader.md)

docs/hooks/use-loader.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ title: Use Loader
44
parent: Hooks
55
nav_order: 13
66
---
7-
87
[React18 Loaders](../index.md) / hooks/use-loader
98

109
# hooks/use-loader
@@ -15,7 +14,7 @@ nav_order: 13
1514

1615
> **useLoader**(): `object`
1716
18-
Defined in: [hooks/use-loader.ts:8](https://github.com/react18-tools/turborepo-template/blob/2635c856ec31df0d27eb77876e3eb8707c5d4b76/lib/src/hooks/use-loader.ts#L8)
17+
Defined in: [hooks/use-loader.ts:8](https://github.com/react18-tools/turborepo-template/blob/7e25a06c2e585bd4aae84dc3767c674dbbee497c/lib/src/hooks/use-loader.ts#L8)
1918

2019
#### Returns
2120

docs/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
layout: default
3-
title: Docs
3+
title: Home
44
nav_order: 2
55
has_children: true
66
---
7-
87
# React18 Loaders <img src="https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png" style="height: 40px"/>
98

109
[![test](https://github.com/react18-tools/turborepo-template/actions/workflows/test.yml/badge.svg)](https://github.com/react18-tools/turborepo-template/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/aa896ec14c570f3bb274/maintainability)](https://codeclimate.com/github/react18-tools/turborepo-template/maintainability) [![codecov](https://codecov.io/gh/react18-tools/turborepo-template/graph/badge.svg)](https://codecov.io/gh/react18-tools/turborepo-template) [![Version](https://img.shields.io/npm/v/react18-loaders.svg?colorB=green)](https://www.npmjs.com/package/react18-loaders) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/d18m/react18-loaders.svg)](https://www.npmjs.com/package/react18-loaders) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/react18-loaders) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/from-referrer/)

docs/server/bars/bars1/bars1.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ title: Bars1
44
parent: Bars1
55
nav_order: 20
66
---
7-
87
[React18 Loaders](../../../index.md) / server/bars/bars1/bars1
98

109
# server/bars/bars1/bars1
@@ -15,7 +14,7 @@ nav_order: 20
1514

1615
> **Bars1**(`props`): `Element`
1716
18-
Defined in: [server/bars/bars1/bars1.tsx:10](https://github.com/react18-tools/turborepo-template/blob/2635c856ec31df0d27eb77876e3eb8707c5d4b76/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/7e25a06c2e585bd4aae84dc3767c674dbbee497c/lib/src/server/bars/bars1/bars1.tsx#L10)
1918

2019
A simple loader with 3 dots.
2120

docs/server/bars/bars1/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
layout: default
33
title: Bars1
4+
parent: Bars
45
nav_order: 18
56
has_children: true
67
---
7-
88
# Bars1
9-
10-
- [Bars1](bars1.md)
9+
- [Bars1](bars1.md)

0 commit comments

Comments
 (0)