Skip to content

Commit

Permalink
fix(core): added translations for 'jp' and 'zh'
Browse files Browse the repository at this point in the history
  • Loading branch information
tgreyuk committed Jun 17, 2024
1 parent e06b849 commit 482d5a1
Show file tree
Hide file tree
Showing 109 changed files with 1,517 additions and 1,376 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,20 @@

# initialize

## Contents

* [Functions](#functions)
* [load()](#load)

## Functions

### load()
## load()

> **load**(`app`): `void`
#### Parameters
### Parameters

| Parameter | Type |
| --------- | ----------------------------------------------------------------- |
| `app` | [`Application`](https://typedoc.org/api/classes/Application.html) |

#### Returns
### Returns

`void`

#### Defined in
### Defined in

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

## Contents

* [Functions](#functions)
* [getResolvedTags()](#getresolvedtags)
* [getFrontmatterTags()](#getfrontmattertags)
* [getResolvedTags()](#getresolvedtags)
* [getFrontmatterTags()](#getfrontmattertags)

## Functions

### getResolvedTags()
## getResolvedTags()

> **getResolvedTags**(`app`, `comment`?): `object`
#### Parameters
### Parameters

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

#### Returns
### Returns

`object`

#### Defined in
### Defined in

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

***

### getFrontmatterTags()
## getFrontmatterTags()

> **getFrontmatterTags**(`comment`, `frontmatterTags`, `namingConvention`): `object`
#### Parameters
### Parameters

| Parameter | Type |
| ------------------ | ------------------------------------------------------------------------------------------------------------- |
| `comment` | [`Comment`](https://typedoc.org/api/types/Models.Comment.html) |
| `frontmatterTags` | `string`\[] |
| `namingConvention` | [`FrontmatterNamingConvention`](../../../options/namespaces/maps/enumerations/FrontmatterNamingConvention.md) |

#### Returns
### Returns

`object`

#### Defined in
### Defined in

[app/tags.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/app/tags.ts#L28)
[app/tags.ts:28](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/app/tags.ts#L28)
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,14 @@

## Contents

* [Variables](#variables)
* [frontmatterGlobals](#frontmatterglobals)
* [readmeFrontmatter](#readmefrontmatter)
* [indexFrontmatter](#indexfrontmatter)
* [frontmatterCommentTags](#frontmattercommenttags)
* [preserveFrontmatterCommentTags](#preservefrontmattercommenttags)
* [frontmatterNamingConvention](#frontmatternamingconvention)
* [frontmatterGlobals](#frontmatterglobals)
* [readmeFrontmatter](#readmefrontmatter)
* [indexFrontmatter](#indexfrontmatter)
* [frontmatterCommentTags](#frontmattercommenttags)
* [preserveFrontmatterCommentTags](#preservefrontmattercommenttags)
* [frontmatterNamingConvention](#frontmatternamingconvention)

## Variables

### frontmatterGlobals
## frontmatterGlobals

> `const` **frontmatterGlobals**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)>
Expand All @@ -25,13 +22,13 @@ sidebar: true
---
```

#### Example
### Example

```ts
{"layout": "docs", "sidebar": true }
```

#### Default Value
### Default Value

```ts
{
Expand All @@ -41,23 +38,23 @@ sidebar: true
}
```

#### Defined in
### Defined in

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

***

### readmeFrontmatter
## readmeFrontmatter

> `const` **readmeFrontmatter**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)>
#### Example
### Example

```ts
{"onReadme": "true" }
```

#### Default Value
### Default Value

```ts
{
Expand All @@ -67,23 +64,23 @@ sidebar: true
}
```

#### Defined in
### Defined in

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

***

### indexFrontmatter
## indexFrontmatter

> `const` **indexFrontmatter**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)>
#### Example
### Example

```ts
{"onIndex": "true" }
```

#### Default Value
### Default Value

```ts
{
Expand All @@ -93,13 +90,13 @@ sidebar: true
}
```

#### Defined in
### Defined in

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

***

### frontmatterCommentTags
## frontmatterCommentTags

> `const` **frontmatterCommentTags**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)>
Expand All @@ -122,13 +119,13 @@ description: A description that will be added to frontmatter.
---
```

#### Example
### Example

```ts
["author", "description"]
```

#### Default Value
### Default Value

```ts
{
Expand All @@ -137,17 +134,17 @@ description: A description that will be added to frontmatter.
}
```

#### Defined in
### Defined in

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

***

### preserveFrontmatterCommentTags
## preserveFrontmatterCommentTags

> `const` **preserveFrontmatterCommentTags**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)>
#### Default Value
### Default Value

```ts
{
Expand All @@ -157,21 +154,21 @@ description: A description that will be added to frontmatter.
}
```

#### Defined in
### Defined in

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

***

### frontmatterNamingConvention
## frontmatterNamingConvention

> `const` **frontmatterNamingConvention**: `Partial`\<[`DeclarationOption`](https://typedoc.org/api/types/Configuration.DeclarationOption.html)>
Block tags have to be written in camelCase (see [tsdoc.org](https://tsdoc.org/pages/spec/tag_kinds)).

This option can configure the output style of frontmatter variables when written to YAML.

#### Default Value
### Default Value

```ts
{
Expand All @@ -182,6 +179,6 @@ This option can configure the output style of frontmatter variables when written
}
```

#### Defined in
### Defined in

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

# maps

## Contents

* [Index](#index)
* [Enumerations](#enumerations)

## Index

### Enumerations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

# Enumeration: FrontmatterNamingConvention

## Contents

* [Enumeration Members](#enumeration-members)

## Enumeration Members

| Enumeration Member | Value |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,6 @@

# types

## Contents

* [Index](#index)
* [Options](#options)
* [Other](#other)

## Index

### Options
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,6 @@

Describes the options declared by the plugin.

## Contents

* [Properties](#properties)
* [frontmatterCommentTags](#frontmattercommenttags)
* [frontmatterGlobals](#frontmatterglobals)
* [frontmatterNamingConvention](#frontmatternamingconvention)
* [indexFrontmatter](#indexfrontmatter)
* [preserveFrontmatterCommentTags](#preservefrontmattercommenttags)
* [readmeFrontmatter](#readmefrontmatter)

## Properties

### frontmatterCommentTags
Expand All @@ -24,7 +14,7 @@ Specify which comment block tags should be added to frontmatter.

#### Defined in

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

***

Expand All @@ -36,7 +26,7 @@ Specify static variables to be added to all frontmatter blocks.

#### Defined in

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

***

Expand All @@ -48,7 +38,7 @@ The naming convention that variables should be output as.

#### Defined in

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

***

Expand All @@ -60,7 +50,7 @@ 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/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/options/types.ts#L31)
[options/types.ts:31](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/types.ts#L31)

***

Expand All @@ -72,7 +62,7 @@ Preserve tags defined in frontmatter block tags in output.

#### Defined in

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

***

Expand All @@ -84,4 +74,4 @@ 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/ca82c8abd3682b5495f6a7750ba0ce30ff4e4f1e/packages/typedoc-plugin-frontmatter/src/options/types.ts#L41)
[options/types.ts:41](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/12bf51d00a65a847fc03f2dc9341a184b33a3504/packages/typedoc-plugin-frontmatter/src/options/types.ts#L41)
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@

Contains all the events and overrides of the typedoc Application.

## Contents

* [Index](#index)
* [Classes](#classes)

## Index

### Classes
Expand Down
Loading

0 comments on commit 482d5a1

Please sign in to comment.