Skip to content

Commit cfe7c58

Browse files
committed
chore(core): updated packages and typings
1 parent beb8931 commit cfe7c58

File tree

65 files changed

+3564
-3260
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+3564
-3260
lines changed

devguide/docusaurus-plugin-typedoc/index/interfaces/PluginOptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ typedoc-plugin-markdown/dist/types/options.d.ts:64
369369

370370
### indexFormat
371371

372-
> **indexFormat**: `"table"` | `"list"`
372+
> **indexFormat**: `"table"` | `"list"` | `"htmlTable"`
373373
374374
Sets the format of index items.
375375

devguide/typedoc-github-wiki-theme/index/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,17 @@ The plugin entrypoint and bootstrapping of the plugin.
1515
1616
### Parameters
1717

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

2222
### Returns
2323

2424
`void`
2525

2626
### Defined in
2727

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

3030
***
3131

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

4646
### Defined in
4747

48-
[index.ts:78](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/index.ts#L78)
48+
[index.ts:73](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-github-wiki-theme/src/index.ts#L73)

devguide/typedoc-gitlab-wiki-theme/index/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ The plugin entrypoint and bootstrapping of the plugin.
1010
1111
### Parameters
1212

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

1717
### Returns
1818

1919
`void`
2020

2121
### Defined in
2222

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

devguide/typedoc-plugin-frontmatter/index/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ The plugin entrypoint and bootstrapping of the plugin.
1010
1111
### Parameters
1212

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

1717
### Returns
1818

1919
`void`
2020

2121
### Defined in
2222

23-
[index.ts:18](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/index.ts#L18)
23+
[index.ts:20](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/index.ts#L20)

devguide/typedoc-plugin-frontmatter/options/namespaces/declarations/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ In addition any non standard tags should be added to a `tsdoc.json` file and add
127127
"extends": ["typedoc/tsdoc.json"],
128128
"tagDefinitions": [
129129
{
130-
"tagName": "@author",
130+
"tagName": "@customTag",
131131
"syntaxKind": "modifier"
132132
}
133133
]

devguide/typedoc-plugin-frontmatter/tags/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,18 @@ Functionality to map options to tags.
1515
1616
### Parameters
1717

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

2323
### Returns
2424

2525
`object`
2626

2727
### Defined in
2828

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

3131
***
3232

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

4949
### Defined in
5050

51-
[tags.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/tags.ts#L33)
51+
[tags.ts:34](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-frontmatter/src/tags.ts#L34)

devguide/typedoc-plugin-markdown/events/classes/MarkdownPageEvent.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflecti
3939

4040
#### Defined in
4141

42-
[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)
42+
[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)
4343

4444
***
4545

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

5353
#### Defined in
5454

55-
[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)
55+
[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)
5656

5757
***
5858

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

6767
#### Defined in
6868

69-
[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)
69+
[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)
7070

7171
***
7272

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

7979
#### Defined in
8080

81-
[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)
81+
[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)
8282

8383
***
8484

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

9191
#### Defined in
9292

93-
[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)
93+
[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)
9494

9595
***
9696

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

103103
#### Defined in
104104

105-
[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)
105+
[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)
106106

107107
## Events
108108

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

115115
#### Defined in
116116

117-
[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)
117+
[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)
118118

119119
***
120120

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

127127
#### Defined in
128128

129-
[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)
129+
[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)

devguide/typedoc-plugin-markdown/events/classes/MarkdownRendererEvent.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The project the renderer is currently processing.
3030

3131
#### Defined in
3232

33-
[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)
33+
[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)
3434

3535
***
3636

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

4343
#### Defined in
4444

45-
[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)
45+
[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)
4646

4747
***
4848

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

5555
#### Defined in
5656

57-
[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)
57+
[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)
5858

5959
***
6060

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

6767
#### Defined in
6868

69-
[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)
69+
[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)
7070

7171
## Events
7272

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

7979
#### Defined in
8080

81-
[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)
81+
[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)
8282

8383
***
8484

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

9191
#### Defined in
9292

93-
[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)
93+
[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)

devguide/typedoc-plugin-markdown/index/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ This method is not intended to be consumed in any other context that via the `pl
3030

3131
### Defined in
3232

33-
[index.ts:30](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/index.ts#L30)
33+
[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)

devguide/typedoc-plugin-markdown/internationalization/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ These will then be merged with the main set of TypeDoc string.
4040

4141
#### Defined in
4242

43-
[internationalization/translatable.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/translatable.ts#L16)
43+
[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)
4444

4545
## Locales
4646

@@ -74,7 +74,7 @@ Translations for 'en' locale.
7474

7575
#### Defined in
7676

77-
[internationalization/locales/en.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts#L7)
77+
[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)
7878

7979
***
8080

@@ -108,7 +108,7 @@ Translations for 'jp' locale.
108108

109109
#### Defined in
110110

111-
[internationalization/locales/jp.ts:8](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts#L8)
111+
[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)
112112

113113
***
114114

@@ -142,7 +142,7 @@ Translations for 'ko' locale.
142142

143143
#### Defined in
144144

145-
[internationalization/locales/ko.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts#L7)
145+
[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)
146146

147147
***
148148

@@ -176,4 +176,4 @@ Translations for 'zh' locale.
176176

177177
#### Defined in
178178

179-
[internationalization/locales/zh.ts:7](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts#L7)
179+
[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)

0 commit comments

Comments
 (0)