Skip to content

Commit

Permalink
docs(generation): fix docs generation issue
Browse files Browse the repository at this point in the history
- Update typedoc.json.
  - Update `entryPoint` to `src`.
  - Use `expand` `entryPointStrategy` to convert entry points into documentation modules.
- Update generate-docs.sh script to remove auto-generated README.md files at root of every generated module.
  - Ignore docusaurus broken-markdown-link warning due to missing README.
- Delete custom-output plugin.
  - Plugin no longer needed with new generation strategy.
  - Use default naming to match docs file structure with src.
  • Loading branch information
hiyaryan committed Jan 8, 2025
1 parent 66083ff commit 1019e48
Show file tree
Hide file tree
Showing 38 changed files with 25,506 additions and 32 deletions.
31 changes: 31 additions & 0 deletions docs/app/(access)/account/page/functions/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
[**the-cdj-ui**](../../../../../README.md)

***

[the-cdj-ui](../../../../../README.md) / [app/(access)/account/page](../README.md) / default

# Function: default()

> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode`
## Parameters

### props

### deprecatedLegacyContext?

`any`

**Deprecated**

**See**

[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods)

## Returns

`ReactNode`

## Defined in

[src/app/(access)/account/page.tsx:3](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/(access)/account/page.tsx#L3)
31 changes: 31 additions & 0 deletions docs/app/(access)/forgot-password/page/functions/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
[**the-cdj-ui**](../../../../../README.md)

***

[the-cdj-ui](../../../../../README.md) / [app/(access)/forgot-password/page](../README.md) / default

# Function: default()

> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode`
## Parameters

### props

### deprecatedLegacyContext?

`any`

**Deprecated**

**See**

[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods)

## Returns

`ReactNode`

## Defined in

[src/app/(access)/forgot-password/page.tsx:3](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/(access)/forgot-password/page.tsx#L3)
31 changes: 31 additions & 0 deletions docs/app/(access)/login/page/functions/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
[**the-cdj-ui**](../../../../../README.md)

***

[the-cdj-ui](../../../../../README.md) / [app/(access)/login/page](../README.md) / default

# Function: default()

> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode`
## Parameters

### props

### deprecatedLegacyContext?

`any`

**Deprecated**

**See**

[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods)

## Returns

`ReactNode`

## Defined in

[src/app/(access)/login/page.tsx:3](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/(access)/login/page.tsx#L3)
31 changes: 31 additions & 0 deletions docs/app/(access)/register/page/functions/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
[**the-cdj-ui**](../../../../../README.md)

***

[the-cdj-ui](../../../../../README.md) / [app/(access)/register/page](../README.md) / default

# Function: default()

> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode`
## Parameters

### props

### deprecatedLegacyContext?

`any`

**Deprecated**

**See**

[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods)

## Returns

`ReactNode`

## Defined in

[src/app/(access)/register/page.tsx:3](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/(access)/register/page.tsx#L3)
31 changes: 31 additions & 0 deletions docs/app/(access)/reset-password/page/functions/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
[**the-cdj-ui**](../../../../../README.md)

***

[the-cdj-ui](../../../../../README.md) / [app/(access)/reset-password/page](../README.md) / default

# Function: default()

> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode`
## Parameters

### props

### deprecatedLegacyContext?

`any`

**Deprecated**

**See**

[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods)

## Returns

`ReactNode`

## Defined in

[src/app/(access)/reset-password/page.tsx:3](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/(access)/reset-password/page.tsx#L3)
31 changes: 31 additions & 0 deletions docs/app/(entry)/index/page/functions/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
[**the-cdj-ui**](../../../../../README.md)

***

[the-cdj-ui](../../../../../README.md) / [app/(entry)/index/page](../README.md) / default

# Function: default()

> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode`
## Parameters

### props

### deprecatedLegacyContext?

`any`

**Deprecated**

**See**

[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods)

## Returns

`ReactNode`

## Defined in

[src/app/(entry)/index/page.tsx:3](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/(entry)/index/page.tsx#L3)
25 changes: 25 additions & 0 deletions docs/app/layout/functions/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
[**the-cdj-ui**](../../../README.md)

***

[the-cdj-ui](../../../README.md) / [app/layout](../README.md) / default

# Function: default()

> **default**(`__namedParameters`): `Element`
## Parameters

### \_\_namedParameters

#### children

`ReactNode`

## Returns

`Element`

## Defined in

[src/app/layout.tsx:10](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/layout.tsx#L10)
17 changes: 17 additions & 0 deletions docs/app/not-found/functions/NotFoundContent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[**the-cdj-ui**](../../../README.md)

***

[the-cdj-ui](../../../README.md) / [app/not-found](../README.md) / NotFoundContent

# Function: NotFoundContent()

> **NotFoundContent**(): `Element`
## Returns

`Element`

## Defined in

[src/app/not-found.tsx:9](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/not-found.tsx#L9)
13 changes: 13 additions & 0 deletions docs/app/not-found/variables/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[**the-cdj-ui**](../../../README.md)

***

[the-cdj-ui](../../../README.md) / [app/not-found](../README.md) / default

# Variable: default

> `const` **default**: `ComponentType`\<\{\}\>
## Defined in

[src/app/not-found.tsx:80](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/not-found.tsx#L80)
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[**the-cdj-ui**](../README.md)
[**the-cdj-ui**](../../../README.md)

***

[the-cdj-ui](../README.md) / default
[the-cdj-ui](../../../README.md) / [app/page](../README.md) / default

# Function: default()

Expand All @@ -18,4 +18,4 @@ application.

## Defined in

[page.tsx:8](https://github.com/hiyaryan/the-cdj-ui/blob/b8e1b6af9ddc33969bbe4132b67de35ad0c004db/src/app/page.tsx#L8)
[src/app/page.tsx:8](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/app/page.tsx#L8)
33 changes: 33 additions & 0 deletions docs/components/atoms/Button/functions/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
[**the-cdj-ui**](../../../../README.md)

***

[the-cdj-ui](../../../../README.md) / [components/atoms/Button](../README.md) / default

# Function: default()

> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode`
## Parameters

### props

[`ButtonProps`](../../../../types/Button.types/interfaces/ButtonProps.md)

### deprecatedLegacyContext?

`any`

**Deprecated**

**See**

[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods)

## Returns

`ReactNode`

## Defined in

[src/components/atoms/Button.tsx:7](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/components/atoms/Button.tsx#L7)
33 changes: 33 additions & 0 deletions docs/components/atoms/Checkbox/functions/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
[**the-cdj-ui**](../../../../README.md)

***

[the-cdj-ui](../../../../README.md) / [components/atoms/Checkbox](../README.md) / default

# Function: default()

> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode`
## Parameters

### props

[`CheckboxProps`](../../../../types/Checkbox.types/interfaces/CheckboxProps.md)

### deprecatedLegacyContext?

`any`

**Deprecated**

**See**

[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods)

## Returns

`ReactNode`

## Defined in

[src/components/atoms/Checkbox.tsx:6](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/components/atoms/Checkbox.tsx#L6)
33 changes: 33 additions & 0 deletions docs/components/atoms/Input/functions/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
[**the-cdj-ui**](../../../../README.md)

***

[the-cdj-ui](../../../../README.md) / [components/atoms/Input](../README.md) / default

# Function: default()

> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode`
## Parameters

### props

[`InputProps`](../../../../types/Input.types/interfaces/InputProps.md)

### deprecatedLegacyContext?

`any`

**Deprecated**

**See**

[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods)

## Returns

`ReactNode`

## Defined in

[src/components/atoms/Input.tsx:7](https://github.com/hiyaryan/the-cdj-ui/blob/66083ffd99c70e3de7b7a7a2d26584eb05be11c4/src/components/atoms/Input.tsx#L7)
Loading

0 comments on commit 1019e48

Please sign in to comment.