microsoft/Typedoc-Webpack-Plugin

Properties with multiple allowable types render incorrectly

theholla opened this issue · 1 comments

Issue:

When a property has multiple allowable types, the asterisks that are supposed to italicize the property types have a space between the type and the asterisk. For example: * string | boolean *. When the markdown file is generated, this results in a stray asterisk before the types, and a stray bullet below.

Proposed solution:

When a property can have multiple types, the asterisks should be located immediately next to the types, with no space, like this: *string | boolean*.

The following sample interface would exhibit this behavior:

export interface ISettings {
  aSetting: string | boolean;
}

Which renders the following (broken) markdown:

## Properties

<a id="asetting"></a>

###  aSetting

**● aSetting**: * `boolean` &#124; `string`
*

*Defined in [path/to/file](https://path/to/github/file)*

See the following screenshot:

markdown

Created an issue in the typedoc-markdown-plugin repo instead