Skip to content

Commit 2635c85

Browse files
committed
test improved docs
1 parent 4b85546 commit 2635c85

File tree

29 files changed

+309
-120
lines changed

29 files changed

+309
-120
lines changed

_config.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@ remote_theme: just-the-docs/just-the-docs
22
title: React18 Loaders
33
search_enabled: true
44
nav_sort: case_insensitive
5-
baseurl: "/turborepo-template"
6-
url: "https://react18-tools.github.io"
5+
footer_content: <p align="center" style="text-align:center">with 💖 by <a href="https://mayank-chaudhari.vercel.app" target="_blank">Mayank Kumar Chaudhari</a></p>

docs/_config.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@ remote_theme: just-the-docs/just-the-docs
22
title: React18 Loaders
33
search_enabled: true
44
nav_sort: case_insensitive
5-
baseurl: "/turborepo-template"
6-
url: "https://react18-tools.github.io"
5+
footer_content: <p align="center" style="text-align:center">with 💖 by <a href="https://mayank-chaudhari.vercel.app" target="_blank">Mayank Kumar Chaudhari</a></p>

docs/client/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
layout: default
3+
title: Client
4+
nav_order: 4
5+
has_children: true
6+
---
7+
8+
# Client
9+
10+
- [Loader Container](loader-container/)

docs/client/loader-container/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
layout: default
3+
title: Loader Container
4+
nav_order: 6
5+
has_children: true
6+
---
7+
8+
# Loader Container
9+
10+
- [Loader Container](loader-container/)
Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
---
22
layout: default
33
title: Internal
4-
nav_order: 5
4+
parent: Loader Container
5+
nav_order: 10
56
---
6-
7-
[React18 Loaders](../../../modules.md) / [client/loader-container/loader-container](index.md) / \<internal\>
7+
8+
[React18 Loaders](../../../index.md) / [client/loader-container/loader-container](index.md) / \<internal\>
89

910
# \<internal\>
1011

1112
## Interfaces
1213

1314
### LoaderContainerProps
1415

15-
Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/react18-tools/turborepo-template/blob/e8bb784e4debcd6d2b76724a3d00adb5da77b685/lib/src/client/loader-container/loader-container.tsx#L5)
16+
Defined in: [client/loader-container/loader-container.tsx:5](https://github.com/react18-tools/turborepo-template/blob/4b8554662427f3787083152b892932bcf7e15c3e/lib/src/client/loader-container/loader-container.tsx#L5)
1617

1718
#### Extends
1819

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

2526
> `optional` **children**: `ReactNode`
2627
27-
Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/react18-tools/turborepo-template/blob/e8bb784e4debcd6d2b76724a3d00adb5da77b685/lib/src/client/loader-container/loader-container.tsx#L6)
28+
Defined in: [client/loader-container/loader-container.tsx:6](https://github.com/react18-tools/turborepo-template/blob/4b8554662427f3787083152b892932bcf7e15c3e/lib/src/client/loader-container/loader-container.tsx#L6)
2829

2930
###### Overrides
3031

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

3536
> `optional` **loading**: `boolean`
3637
37-
Defined in: [client/loader-container/loader-container.tsx:7](https://github.com/react18-tools/turborepo-template/blob/e8bb784e4debcd6d2b76724a3d00adb5da77b685/lib/src/client/loader-container/loader-container.tsx#L7)
38+
Defined in: [client/loader-container/loader-container.tsx:7](https://github.com/react18-tools/turborepo-template/blob/4b8554662427f3787083152b892932bcf7e15c3e/lib/src/client/loader-container/loader-container.tsx#L7)

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
layout: default
33
title: Loader Container
4-
nav_order: 4
4+
nav_order: 9
5+
has_children: true
56
---
6-
7-
[React18 Loaders](../../../modules.md) / client/loader-container/loader-container
7+
8+
[React18 Loaders](../../../index.md) / client/loader-container/loader-container
89

910
# client/loader-container/loader-container
1011

@@ -18,7 +19,7 @@ nav_order: 4
1819

1920
> **LoaderContainer**(`__namedParameters`): `Element`
2021
21-
Defined in: [client/loader-container/loader-container.tsx:14](https://github.com/react18-tools/turborepo-template/blob/e8bb784e4debcd6d2b76724a3d00adb5da77b685/lib/src/client/loader-container/loader-container.tsx#L14)
22+
Defined in: [client/loader-container/loader-container.tsx:14](https://github.com/react18-tools/turborepo-template/blob/4b8554662427f3787083152b892932bcf7e15c3e/lib/src/client/loader-container/loader-container.tsx#L14)
2223

2324
# LoaderContainer
2425

docs/constants.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
layout: default
33
title: Constants
4-
nav_order: 2
4+
parent: Docs
5+
nav_order: 3
56
---
6-
7-
[React18 Loaders](modules.md) / constants
7+
8+
[React18 Loaders](index.md) / constants
89

910
# constants
1011

@@ -14,6 +15,6 @@ nav_order: 2
1415

1516
> `const` **LOADER_RGS_KEY**: `"r18-loaders"` = `"r18-loaders"`
1617
17-
Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/e8bb784e4debcd6d2b76724a3d00adb5da77b685/lib/src/constants.ts#L3)
18+
Defined in: [constants.ts:3](https://github.com/react18-tools/turborepo-template/blob/4b8554662427f3787083152b892932bcf7e15c3e/lib/src/constants.ts#L3)
1819

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

docs/hooks/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
layout: default
3+
title: Hooks
4+
nav_order: 11
5+
has_children: true
6+
---
7+
8+
# Hooks
9+
10+
- [Use Loader](use-loader.md)

docs/hooks/use-loader.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
layout: default
33
title: Use Loader
4-
nav_order: 6
4+
parent: Hooks
5+
nav_order: 13
56
---
6-
7-
[React18 Loaders](../modules.md) / hooks/use-loader
7+
8+
[React18 Loaders](../index.md) / hooks/use-loader
89

910
# hooks/use-loader
1011

@@ -14,7 +15,7 @@ nav_order: 6
1415

1516
> **useLoader**(): `object`
1617
17-
Defined in: [hooks/use-loader.ts:8](https://github.com/react18-tools/turborepo-template/blob/e8bb784e4debcd6d2b76724a3d00adb5da77b685/lib/src/hooks/use-loader.ts#L8)
18+
Defined in: [hooks/use-loader.ts:8](https://github.com/react18-tools/turborepo-template/blob/4b8554662427f3787083152b892932bcf7e15c3e/lib/src/hooks/use-loader.ts#L8)
1819

1920
#### Returns
2021

docs/index.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
22
layout: default
3-
title: React 18 Loaders
4-
nav_order: 1
3+
title: Docs
4+
nav_order: 2
5+
has_children: true
56
---
6-
7+
78
# React18 Loaders <img src="https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png" style="height: 40px"/>
89

910
[![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/)
@@ -136,3 +137,14 @@ This library is licensed under the MPL-2.0 open-source license.
136137
<hr />
137138

138139
<p align="center" style="text-align:center">with 💖 by <a href="https://mayank-chaudhari.vercel.app" target="_blank">Mayank Kumar Chaudhari</a></p>
140+
141+
## Modules
142+
143+
- [client/loader-container/loader-container](client/loader-container/loader-container/index.md)
144+
- [constants](constants.md)
145+
- [hooks/use-loader](hooks/use-loader.md)
146+
- [server/bars/bars1/bars1](server/bars/bars1/bars1.md)
147+
- [server/bars/bars2/bars2](server/bars/bars2/bars2.md)
148+
- [server/common/base/base](server/common/base/base/index.md)
149+
- [server/dots/dots1/dots1](server/dots/dots1/dots1.md)
150+
- [server/dots/dots2/dots2](server/dots/dots2/dots2/index.md)

0 commit comments

Comments
 (0)