Skip to content

Commit

Permalink
feat(core): split out propertiesFormat for classes and interfaces
Browse files Browse the repository at this point in the history
  • Loading branch information
tgreyuk committed Jun 17, 2024
1 parent 482d5a1 commit b271f8f
Show file tree
Hide file tree
Showing 58 changed files with 988 additions and 24,489 deletions.
22,534 changes: 0 additions & 22,534 deletions devdocs-json.json

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@

### Defined in

[app/initialize.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/app/initialize.ts#L13)
[app/initialize.ts:13](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/app/initialize.ts#L13)
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

### Defined in

[app/tags.ts:4](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/app/tags.ts#L4)
[app/tags.ts:4](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/app/tags.ts#L4)

***

Expand All @@ -46,4 +46,4 @@

### Defined in

[app/tags.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/app/tags.ts#L28)
[app/tags.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/app/tags.ts#L28)
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ sidebar: true

### Defined in

[options/declarations.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L15)
[options/declarations.ts:15](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L15)

***

Expand All @@ -66,7 +66,7 @@ sidebar: true

### Defined in

[options/declarations.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L24)
[options/declarations.ts:24](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L24)

***

Expand All @@ -92,7 +92,7 @@ sidebar: true

### Defined in

[options/declarations.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L33)
[options/declarations.ts:33](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L33)

***

Expand Down Expand Up @@ -136,7 +136,7 @@ description: A description that will be added to frontmatter.

### Defined in

[options/declarations.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L61)
[options/declarations.ts:61](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L61)

***

Expand All @@ -156,7 +156,7 @@ description: A description that will be added to frontmatter.

### Defined in

[options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L66)
[options/declarations.ts:66](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L66)

***

Expand All @@ -181,4 +181,4 @@ This option can configure the output style of frontmatter variables when written

### Defined in

[options/declarations.ts:77](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L77)
[options/declarations.ts:77](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-frontmatter/src/options/declarations.ts#L77)
Original file line number Diff line number Diff line change
Expand Up @@ -6,72 +6,11 @@ Describes the options declared by the plugin.

## Properties

### frontmatterCommentTags

> **frontmatterCommentTags**: `any`\[]
Specify which comment block tags should be added to frontmatter.

#### Defined in

[options/types.ts:16](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/types.ts#L16)

***

### frontmatterGlobals

> **frontmatterGlobals**: [`FrontmatterGlobals`](FrontmatterGlobals.md)
Specify static variables to be added to all frontmatter blocks.

#### Defined in

[options/types.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/types.ts#L21)

***

### frontmatterNamingConvention

> **frontmatterNamingConvention**: `"camelCase"` | `"snakeCase"`
The naming convention that variables should be output as.

#### Defined in

[options/types.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/types.ts#L26)

***

### indexFrontmatter

> **indexFrontmatter**: [`IndexFrontmatter`](IndexFrontmatter.md)
Specify static variables to be added to the index page only.

#### Defined in

[options/types.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/types.ts#L31)

***

### preserveFrontmatterCommentTags

> **preserveFrontmatterCommentTags**: `boolean`
Preserve tags defined in frontmatter block tags in output.

#### Defined in

[options/types.ts:36](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/types.ts#L36)

***

### readmeFrontmatter

> **readmeFrontmatter**: [`ReadmeFrontmatter`](ReadmeFrontmatter.md)
Specify static variables to be added to the readme page only.

#### Defined in

[options/types.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/types.ts#L41)
| Property | Type | Description |
| -------------------------------- | --------------------------------------------- | ---------------------------------------------------------------- |
| `frontmatterCommentTags` | `any`\[] | Specify which comment block tags should be added to frontmatter. |
| `frontmatterGlobals` | [`FrontmatterGlobals`](FrontmatterGlobals.md) | Specify static variables to be added to all frontmatter blocks. |
| `frontmatterNamingConvention` | `"camelCase"` \| `"snakeCase"` | The naming convention that variables should be output as. |
| `indexFrontmatter` | [`IndexFrontmatter`](IndexFrontmatter.md) | Specify static variables to be added to the index page only. |
| `preserveFrontmatterCommentTags` | `boolean` | Preserve tags defined in frontmatter block tags in output. |
| `readmeFrontmatter` | [`ReadmeFrontmatter`](ReadmeFrontmatter.md) | Specify static variables to be added to the readme page only. |
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,16 @@ An event emitted by before and after the markup of a page is rendered.
* [frontmatter?](#frontmatter)
* [Accessors](#accessors)
* [name](#name)
* [Inherited from](#inherited-from)
* [isPropagationStopped](#ispropagationstopped)
* [Inherited from](#inherited-from-1)
* [Methods](#methods)
* [stopPropagation()](#stoppropagation)
* [Inherited from](#inherited-from)
* [Inherited from](#inherited-from-2)
* [preventDefault()](#preventdefault)
* [Inherited from](#inherited-from-1)
* [Inherited from](#inherited-from-3)
* [isDefaultPrevented()](#isdefaultprevented)
* [Inherited from](#inherited-from-2)
* [Inherited from](#inherited-from-4)
* [Events](#events)
* [BEGIN](#begin)
* [END](#end)
Expand Down Expand Up @@ -59,7 +61,7 @@ The [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflecti

#### Defined in

[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L22)
[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:22](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L22)

***

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

#### Defined in

[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L28)
[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L28)

***

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

#### Defined in

[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:35](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L35)
[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:35](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L35)

***

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

#### Defined in

[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L40)
[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:40](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L40)

***

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

#### Defined in

[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:45](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L45)
[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:45](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L45)

***

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

#### Defined in

[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L50)
[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:50](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L50)

## Accessors

Expand All @@ -136,6 +138,10 @@ Return the event name.

`string`

#### Inherited from

`Event.name`

#### Defined in

node\_modules/typedoc/dist/lib/utils/events.d.ts:38
Expand All @@ -152,6 +158,10 @@ Has [Event.stopPropagation](MarkdownPageEvent.md#stoppropagation) been called?

`boolean`

#### Inherited from

`Event.isPropagationStopped`

#### Defined in

node\_modules/typedoc/dist/lib/utils/events.d.ts:42
Expand Down Expand Up @@ -226,7 +236,7 @@ Triggered before a document will be rendered.

#### Defined in

[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:62](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L62)
[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:62](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L62)

***

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

#### Defined in

[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:68](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L68)
[packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts:68](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-page-event.ts#L68)
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,16 @@ An event emitted at the beginning and end of the rendering process.
* [navigation?](#navigation)
* [Accessors](#accessors)
* [name](#name)
* [Inherited from](#inherited-from)
* [isPropagationStopped](#ispropagationstopped)
* [Inherited from](#inherited-from-1)
* [Methods](#methods)
* [stopPropagation()](#stoppropagation)
* [Inherited from](#inherited-from)
* [Inherited from](#inherited-from-2)
* [preventDefault()](#preventdefault)
* [Inherited from](#inherited-from-1)
* [Inherited from](#inherited-from-3)
* [isDefaultPrevented()](#isdefaultprevented)
* [Inherited from](#inherited-from-2)
* [Inherited from](#inherited-from-4)
* [Events](#events)
* [BEGIN](#begin)
* [END](#end)
Expand All @@ -48,7 +50,7 @@ The project the renderer is currently processing.

#### Defined in

[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L21)
[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:21](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L21)

***

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

#### Defined in

[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L26)
[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:26](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L26)

***

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

#### Defined in

[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L31)
[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L31)

***

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

#### Defined in

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

## Accessors

Expand All @@ -98,6 +100,10 @@ Return the event name.

`string`

#### Inherited from

`Event.name`

#### Defined in

node\_modules/typedoc/dist/lib/utils/events.d.ts:38
Expand All @@ -114,6 +120,10 @@ Has [Event.stopPropagation](MarkdownPageEvent.md#stoppropagation) been called?

`boolean`

#### Inherited from

`Event.isPropagationStopped`

#### Defined in

node\_modules/typedoc/dist/lib/utils/events.d.ts:42
Expand Down Expand Up @@ -188,7 +198,7 @@ Triggered before the renderer starts rendering a project.

#### Defined in

[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L42)
[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:42](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L42)

***

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

#### Defined in

[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L48)
[packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts:48](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/events/markdown-renderer-event.ts#L48)
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ In summary this method:

### Defined in

[packages/typedoc-plugin-markdown/src/app/\_initialize.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-markdown/src/app/_initialize.ts#L38)
[packages/typedoc-plugin-markdown/src/app/\_initialize.ts:38](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/3222766cbd19cef92f31d344e58bbe5b67a3a528/packages/typedoc-plugin-markdown/src/app/_initialize.ts#L38)
Loading

0 comments on commit b271f8f

Please sign in to comment.