Skip to content

Commit

Permalink
chore(core): updated packages and typings
Browse files Browse the repository at this point in the history
  • Loading branch information
tgreyuk committed Jun 29, 2024
1 parent beb8931 commit cfe7c58
Show file tree
Hide file tree
Showing 65 changed files with 3,564 additions and 3,260 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ typedoc-plugin-markdown/dist/types/options.d.ts:64

### indexFormat

> **indexFormat**: `"table"` | `"list"`
> **indexFormat**: `"table"` | `"list"` | `"htmlTable"`
Sets the format of index items.

Expand Down
10 changes: 5 additions & 5 deletions devguide/typedoc-github-wiki-theme/index/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@ The plugin entrypoint and bootstrapping of the plugin.
### Parameters

| Parameter | Type |
| --------- | ----------------------------------------------------------------- |
| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) |
| Parameter | Type |
| --------- | ---------------------------------------------------------------------------------------------- |
| `app` | [`MarkdownApplication`](../../typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md) |

### Returns

`void`

### Defined in

[index.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/index.ts#L23)
[index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/index.ts#L18)

***

Expand All @@ -45,4 +45,4 @@ The plugin entrypoint and bootstrapping of the plugin.

### Defined in

[index.ts:78](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/index.ts#L78)
[index.ts:73](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/index.ts#L73)
8 changes: 4 additions & 4 deletions devguide/typedoc-gitlab-wiki-theme/index/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ The plugin entrypoint and bootstrapping of the plugin.
### Parameters

| Parameter | Type |
| --------- | ----------------------------------------------------------------- |
| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) |
| Parameter | Type |
| --------- | ---------------------------------------------------------------------------------------------- |
| `app` | [`MarkdownApplication`](../../typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md) |

### Returns

`void`

### Defined in

[index.ts:23](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/index.ts#L23)
[index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-gitlab-wiki-theme/src/index.ts#L18)
8 changes: 4 additions & 4 deletions devguide/typedoc-plugin-frontmatter/index/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ The plugin entrypoint and bootstrapping of the plugin.
### Parameters

| Parameter | Type |
| --------- | ----------------------------------------------------------------- |
| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) |
| Parameter | Type |
| --------- | ---------------------------------------------------------------------------------------------- |
| `app` | [`MarkdownApplication`](../../typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md) |

### Returns

`void`

### Defined in

[index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/index.ts#L18)
[index.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/index.ts#L20)
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ In addition any non standard tags should be added to a `tsdoc.json` file and add
"extends": ["typedoc/tsdoc.json"],
"tagDefinitions": [
{
"tagName": "@author",
"tagName": "@customTag",
"syntaxKind": "modifier"
}
]
Expand Down
12 changes: 6 additions & 6 deletions devguide/typedoc-plugin-frontmatter/tags/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,18 @@ Functionality to map options to tags.
### Parameters

| Parameter | Type |
| ---------- | ----------------------------------------------------------------- |
| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) |
| `comment`? | [`Comment`](https://typedoc.org/api/classes/Models.Comment.html) |
| Parameter | Type |
| ---------- | ---------------------------------------------------------------------------------------------- |
| `app` | [`MarkdownApplication`](../../typedoc-plugin-markdown/types/interfaces/MarkdownApplication.md) |
| `comment`? | [`Comment`](https://typedoc.org/api/classes/Models.Comment.html) |

### Returns

`object`

### Defined in

[tags.ts:9](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/tags.ts#L9)
[tags.ts:10](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/tags.ts#L10)

***

Expand All @@ -48,4 +48,4 @@ Functionality to map options to tags.

### Defined in

[tags.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/tags.ts#L33)
[tags.ts:34](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/tags.ts#L34)
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflecti

#### Defined in

[events/markdown-page-event.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L14)
[packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:14](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L14)

***

Expand All @@ -52,7 +52,7 @@ Either a [`DeclarationReflection`](https://typedoc.org/api/classes/Models.Declar

#### Defined in

[events/markdown-page-event.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L20)
[packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L20)

***

Expand All @@ -66,7 +66,7 @@ Should be rendered by layout templates and can be modified by plugins.

#### Defined in

[events/markdown-page-event.ts:27](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L27)
[packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:27](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L27)

***

Expand All @@ -78,7 +78,7 @@ The url `string` of the page.

#### Defined in

[events/markdown-page-event.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L32)
[packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:32](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L32)

***

Expand All @@ -90,7 +90,7 @@ The complete `string` filename where the file will be written..

#### Defined in

[events/markdown-page-event.ts:37](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L37)
[packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:37](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L37)

***

Expand All @@ -102,7 +102,7 @@ The frontmatter of this page represented as a key value object. This property ca

#### Defined in

[events/markdown-page-event.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L42)
[packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L42)

## Events

Expand All @@ -114,7 +114,7 @@ Triggered before a document will be rendered.

#### Defined in

[events/markdown-page-event.ts:54](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L54)
[packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L48)

***

Expand All @@ -126,4 +126,4 @@ Triggered after a document has been rendered, just before it is written to disc.

#### Defined in

[events/markdown-page-event.ts:60](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L60)
[packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts:54](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts#L54)
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The project the renderer is currently processing.

#### Defined in

[events/markdown-renderer-event.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L15)
[packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L15)

***

Expand All @@ -42,7 +42,7 @@ The path of the directory the documentation should be written to.

#### Defined in

[events/markdown-renderer-event.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L20)
[packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L20)

***

Expand All @@ -54,7 +54,7 @@ A list of all pages that should be generated.

#### Defined in

[events/markdown-renderer-event.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L25)
[packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:25](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L25)

***

Expand All @@ -66,7 +66,7 @@ The navigation structure of the project that can be utilised by plugins.

#### Defined in

[events/markdown-renderer-event.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L30)
[packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L30)

## Events

Expand All @@ -78,7 +78,7 @@ Triggered before the renderer starts rendering a project.

#### Defined in

[events/markdown-renderer-event.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L36)
[packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L36)

***

Expand All @@ -90,4 +90,4 @@ Triggered after the renderer has written all documents.

#### Defined in

[events/markdown-renderer-event.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L42)
[packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/events/markdown-renderer-event.ts#L42)
2 changes: 1 addition & 1 deletion devguide/typedoc-plugin-markdown/index/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ This method is not intended to be consumed in any other context that via the `pl

### Defined in

[index.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/index.ts#L30)
[packages/typedoc-plugin-markdown/src/index.ts:29](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/index.ts#L29)
10 changes: 5 additions & 5 deletions devguide/typedoc-plugin-markdown/internationalization/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ These will then be merged with the main set of TypeDoc string.

#### Defined in

[internationalization/translatable.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/translatable.ts#L16)
[packages/typedoc-plugin-markdown/src/internationalization/translatable.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/translatable.ts#L16)

## Locales

Expand Down Expand Up @@ -74,7 +74,7 @@ Translations for 'en' locale.

#### Defined in

[internationalization/locales/en.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts#L7)
[packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts#L7)

***

Expand Down Expand Up @@ -108,7 +108,7 @@ Translations for 'jp' locale.

#### Defined in

[internationalization/locales/jp.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts#L8)
[packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts#L8)

***

Expand Down Expand Up @@ -142,7 +142,7 @@ Translations for 'ko' locale.

#### Defined in

[internationalization/locales/ko.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts#L7)
[packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts#L7)

***

Expand Down Expand Up @@ -176,4 +176,4 @@ Translations for 'zh' locale.

#### Defined in

[internationalization/locales/zh.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts#L7)
[packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts#L7)
Loading

0 comments on commit cfe7c58

Please sign in to comment.