Skip to content

improvement(api-markdown-documenter): Don't needlessly escape > characters in Markdown #24813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -117,6 +117,6 @@ function splitLeadingAndTrailingWhitespace(text: string): SplitTextResult {
export function escapeTextForMarkdown(text: string): string {
return text
.replace(/\\/g, "\\\\") // first replace the escape character
.replace(/[#&*<>[\]_`|~]/g, (x) => `\\${x}`) // then escape any special characters
.replace(/[#&*<[\]_`|~]/g, (x) => `\\${x}`) // then escape any special characters
.replace(/---/g, "\\-\\-\\-"); // hyphens only if it's 3 or more
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# test-suite-a

[Packages](/) \> [test-suite-a](/test-suite-a/)
[Packages](/) > [test-suite-a](/test-suite-a/)

Test package

@@ -74,7 +74,7 @@ const foo = bar;
| - | - | - | - |
| [testFunction(testParameter, testOptionalParameter)](/test-suite-a/testfunction-function) | `Alpha` | TTypeParameter | Test function |
| [testFunctionReturningInlineType()](/test-suite-a/testfunctionreturninginlinetype-function) | | { foo: number; bar: [TestEnum](/test-suite-a/testenum-enum/); } | Test function that returns an inline type |
| [testFunctionReturningIntersectionType()](/test-suite-a/testfunctionreturningintersectiontype-function) | `Deprecated` | [TestEmptyInterface](/test-suite-a/testemptyinterface-interface/) \& [TestInterfaceWithTypeParameter](/test-suite-a/testinterfacewithtypeparameter-interface/)\<number\> | Test function that returns an inline type |
| [testFunctionReturningIntersectionType()](/test-suite-a/testfunctionreturningintersectiontype-function) | `Deprecated` | [TestEmptyInterface](/test-suite-a/testemptyinterface-interface/) \& [TestInterfaceWithTypeParameter](/test-suite-a/testinterfacewithtypeparameter-interface/)\<number> | Test function that returns an inline type |
| [testFunctionReturningUnionType()](/test-suite-a/testfunctionreturninguniontype-function) | | string \| [TestInterface](/test-suite-a/testinterface-interface/) | Test function that returns an inline type |

## Variables
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# (constructor)

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestAbstractClass](/test-suite-a/testabstractclass-class/) \> [(constructor)(privateProperty, protectedProperty)](/test-suite-a/testabstractclass-class/_constructor_-constructor)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestAbstractClass](/test-suite-a/testabstractclass-class/) > [(constructor)(privateProperty, protectedProperty)](/test-suite-a/testabstractclass-class/_constructor_-constructor)

This is a _{@customTag constructor}_.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# abstractPropertyGetter

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestAbstractClass](/test-suite-a/testabstractclass-class/) \> [abstractPropertyGetter](/test-suite-a/testabstractclass-class/abstractpropertygetter-property)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestAbstractClass](/test-suite-a/testabstractclass-class/) > [abstractPropertyGetter](/test-suite-a/testabstractclass-class/abstractpropertygetter-property)

A test abstract getter property.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TestAbstractClass

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestAbstractClass](/test-suite-a/testabstractclass-class/)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestAbstractClass](/test-suite-a/testabstractclass-class/)

A test abstract class.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# protectedProperty

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestAbstractClass](/test-suite-a/testabstractclass-class/) \> [protectedProperty](/test-suite-a/testabstractclass-class/protectedproperty-property)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestAbstractClass](/test-suite-a/testabstractclass-class/) > [protectedProperty](/test-suite-a/testabstractclass-class/protectedproperty-property)

A test protected property.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# publicAbstractMethod

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestAbstractClass](/test-suite-a/testabstractclass-class/) \> [publicAbstractMethod()](/test-suite-a/testabstractclass-class/publicabstractmethod-method)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestAbstractClass](/test-suite-a/testabstractclass-class/) > [publicAbstractMethod()](/test-suite-a/testabstractclass-class/publicabstractmethod-method)

A test public abstract method.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# sealedMethod

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestAbstractClass](/test-suite-a/testabstractclass-class/) \> [sealedMethod()](/test-suite-a/testabstractclass-class/sealedmethod-method)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestAbstractClass](/test-suite-a/testabstractclass-class/) > [sealedMethod()](/test-suite-a/testabstractclass-class/sealedmethod-method)

A test `@sealed` method.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# virtualMethod

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestAbstractClass](/test-suite-a/testabstractclass-class/) \> [virtualMethod()](/test-suite-a/testabstractclass-class/virtualmethod-method)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestAbstractClass](/test-suite-a/testabstractclass-class/) > [virtualMethod()](/test-suite-a/testabstractclass-class/virtualmethod-method)

A test `@virtual` method.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# alphaMember

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestBetaNamespace](/test-suite-a/testbetanamespace-namespace/) \> [alphaMember](/test-suite-a/testbetanamespace-namespace/alphamember-variable)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestBetaNamespace](/test-suite-a/testbetanamespace-namespace/) > [alphaMember](/test-suite-a/testbetanamespace-namespace/alphamember-variable)

**WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.**

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# betaMember

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestBetaNamespace](/test-suite-a/testbetanamespace-namespace/) \> [betaMember](/test-suite-a/testbetanamespace-namespace/betamember-variable)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestBetaNamespace](/test-suite-a/testbetanamespace-namespace/) > [betaMember](/test-suite-a/testbetanamespace-namespace/betamember-variable)

**WARNING: This API is provided as a beta preview and may change without notice. Use at your own risk.**

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TestBetaNamespace

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestBetaNamespace](/test-suite-a/testbetanamespace-namespace/)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestBetaNamespace](/test-suite-a/testbetanamespace-namespace/)

A namespace tagged as `@beta`.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# publicMember

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestBetaNamespace](/test-suite-a/testbetanamespace-namespace/) \> [publicMember](/test-suite-a/testbetanamespace-namespace/publicmember-variable)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestBetaNamespace](/test-suite-a/testbetanamespace-namespace/) > [publicMember](/test-suite-a/testbetanamespace-namespace/publicmember-variable)

**WARNING: This API is provided as a beta preview and may change without notice. Use at your own risk.**

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# (constructor)

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestClass](/test-suite-a/testclass-class/) \> [(constructor)(privateProperty, protectedProperty, testClassProperty, testClassEventProperty)](/test-suite-a/testclass-class/_constructor_-constructor)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestClass](/test-suite-a/testclass-class/) > [(constructor)(privateProperty, protectedProperty, testClassProperty, testClassEventProperty)](/test-suite-a/testclass-class/_constructor_-constructor)

Test class constructor

@@ -21,4 +21,4 @@ Here are some remarks about the constructor
| privateProperty | number | See [TestAbstractClass](/test-suite-a/testabstractclass-class/)'s constructor. |
| protectedProperty | [TestEnum](/test-suite-a/testenum-enum/) | <p>Some notes about the parameter.</p><p>See <a href="/test-suite-a/testabstractclass-class/protectedproperty-property">protectedProperty</a>.</p> |
| testClassProperty | TTypeParameterB | See [testClassProperty](/test-suite-a/testclass-class/testclassproperty-property). |
| testClassEventProperty | () =\> void | See [testClassEventProperty](/test-suite-a/testclass-class/testclasseventproperty-property). |
| testClassEventProperty | () => void | See [testClassEventProperty](/test-suite-a/testclass-class/testclasseventproperty-property). |
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# abstractPropertyGetter

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestClass](/test-suite-a/testclass-class/) \> [abstractPropertyGetter](/test-suite-a/testclass-class/abstractpropertygetter-property)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestClass](/test-suite-a/testclass-class/) > [abstractPropertyGetter](/test-suite-a/testclass-class/abstractpropertygetter-property)

A test abstract getter property.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TestClass

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestClass](/test-suite-a/testclass-class/)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestClass](/test-suite-a/testclass-class/)

Test class

@@ -33,7 +33,7 @@ Here are some remarks about the class

| Property | Type | Description |
| - | - | - |
| [testClassStaticProperty](/test-suite-a/testclass-class/testclassstaticproperty-property) | (foo: number) =\> string | Test static class property |
| [testClassStaticProperty](/test-suite-a/testclass-class/testclassstaticproperty-property) | (foo: number) => string | Test static class property |

## Static Methods

@@ -45,7 +45,7 @@ Here are some remarks about the class

| Property | Modifiers | Type | Description |
| - | - | - | - |
| [testClassEventProperty](/test-suite-a/testclass-class/testclasseventproperty-property) | `readonly` | () =\> void | Test class event property |
| [testClassEventProperty](/test-suite-a/testclass-class/testclasseventproperty-property) | `readonly` | () => void | Test class event property |

## Properties

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# publicAbstractMethod

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestClass](/test-suite-a/testclass-class/) \> [publicAbstractMethod()](/test-suite-a/testclass-class/publicabstractmethod-method)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestClass](/test-suite-a/testclass-class/) > [publicAbstractMethod()](/test-suite-a/testclass-class/publicabstractmethod-method)

A test public abstract method.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# testClassEventProperty

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestClass](/test-suite-a/testclass-class/) \> [testClassEventProperty](/test-suite-a/testclass-class/testclasseventproperty-property)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestClass](/test-suite-a/testclass-class/) > [testClassEventProperty](/test-suite-a/testclass-class/testclasseventproperty-property)

Test class event property

@@ -10,7 +10,7 @@ Test class event property
readonly testClassEventProperty: () => void;
```

**Type**: () =\> void
**Type**: () => void

## Remarks {#testclasseventproperty-remarks}

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# testClassGetterProperty

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestClass](/test-suite-a/testclass-class/) \> [testClassGetterProperty](/test-suite-a/testclass-class/testclassgetterproperty-property)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestClass](/test-suite-a/testclass-class/) > [testClassGetterProperty](/test-suite-a/testclass-class/testclassgetterproperty-property)

Test class property with both a getter and a setter.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# testClassMethod

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestClass](/test-suite-a/testclass-class/) \> [testClassMethod(input)](/test-suite-a/testclass-class/testclassmethod-method)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestClass](/test-suite-a/testclass-class/) > [testClassMethod(input)](/test-suite-a/testclass-class/testclassmethod-method)

Test class method

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# testClassProperty

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestClass](/test-suite-a/testclass-class/) \> [testClassProperty](/test-suite-a/testclass-class/testclassproperty-property)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestClass](/test-suite-a/testclass-class/) > [testClassProperty](/test-suite-a/testclass-class/testclassproperty-property)

Test class property

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# testClassStaticMethod

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestClass](/test-suite-a/testclass-class/) \> [testClassStaticMethod(foo)](/test-suite-a/testclass-class/testclassstaticmethod-method)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestClass](/test-suite-a/testclass-class/) > [testClassStaticMethod(foo)](/test-suite-a/testclass-class/testclassstaticmethod-method)

Test class static method

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# testClassStaticProperty

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestClass](/test-suite-a/testclass-class/) \> [testClassStaticProperty](/test-suite-a/testclass-class/testclassstaticproperty-property)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestClass](/test-suite-a/testclass-class/) > [testClassStaticProperty](/test-suite-a/testclass-class/testclassstaticproperty-property)

Test static class property

@@ -10,4 +10,4 @@ Test static class property
static testClassStaticProperty: (foo: number) => string;
```

**Type**: (foo: number) =\> string
**Type**: (foo: number) => string
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# virtualMethod

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestClass](/test-suite-a/testclass-class/) \> [virtualMethod()](/test-suite-a/testclass-class/virtualmethod-method)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestClass](/test-suite-a/testclass-class/) > [virtualMethod()](/test-suite-a/testclass-class/virtualmethod-method)

Overrides [virtualMethod()](/test-suite-a/testabstractclass-class/virtualmethod-method).

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# testConst

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [testConst](/test-suite-a/testconst-variable)
[Packages](/) > [test-suite-a](/test-suite-a/) > [testConst](/test-suite-a/testconst-variable)

Test Constant

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# testConstWithEmptyDeprecatedBlock

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [testConstWithEmptyDeprecatedBlock](/test-suite-a/testconstwithemptydeprecatedblock-variable)
[Packages](/) > [test-suite-a](/test-suite-a/) > [testConstWithEmptyDeprecatedBlock](/test-suite-a/testconstwithemptydeprecatedblock-variable)

I have a `@deprecated` tag with an empty comment block.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TestEmptyInterface

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestEmptyInterface](/test-suite-a/testemptyinterface-interface/)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestEmptyInterface](/test-suite-a/testemptyinterface-interface/)

An empty interface

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TestEnum

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestEnum](/test-suite-a/testenum-enum/)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestEnum](/test-suite-a/testenum-enum/)

Test Enum

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TestEnumValue1

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestEnum](/test-suite-a/testenum-enum/) \> [TestEnumValue1](/test-suite-a/testenum-enum/testenumvalue1-enummember)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestEnum](/test-suite-a/testenum-enum/) > [TestEnumValue1](/test-suite-a/testenum-enum/testenumvalue1-enummember)

Test enum value 1 (string)

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TestEnumValue2

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestEnum](/test-suite-a/testenum-enum/) \> [TestEnumValue2](/test-suite-a/testenum-enum/testenumvalue2-enummember)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestEnum](/test-suite-a/testenum-enum/) > [TestEnumValue2](/test-suite-a/testenum-enum/testenumvalue2-enummember)

Test enum value 2 (number)

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TestEnumValue3

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestEnum](/test-suite-a/testenum-enum/) \> [TestEnumValue3](/test-suite-a/testenum-enum/testenumvalue3-enummember)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestEnum](/test-suite-a/testenum-enum/) > [TestEnumValue3](/test-suite-a/testenum-enum/testenumvalue3-enummember)

Test enum value 3 (default)

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# testFunction

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [testFunction(testParameter, testOptionalParameter)](/test-suite-a/testfunction-function)
[Packages](/) > [test-suite-a](/test-suite-a/) > [testFunction(testParameter, testOptionalParameter)](/test-suite-a/testfunction-function)

Test function

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# testFunctionReturningInlineType

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [testFunctionReturningInlineType()](/test-suite-a/testfunctionreturninginlinetype-function)
[Packages](/) > [test-suite-a](/test-suite-a/) > [testFunctionReturningInlineType()](/test-suite-a/testfunctionreturninginlinetype-function)

Test function that returns an inline type

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# testFunctionReturningIntersectionType

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [testFunctionReturningIntersectionType()](/test-suite-a/testfunctionreturningintersectiontype-function)
[Packages](/) > [test-suite-a](/test-suite-a/) > [testFunctionReturningIntersectionType()](/test-suite-a/testfunctionreturningintersectiontype-function)

Test function that returns an inline type

@@ -18,4 +18,4 @@ export declare function testFunctionReturningIntersectionType(): TestEmptyInterf

an intersection type

**Return type**: [TestEmptyInterface](/test-suite-a/testemptyinterface-interface/) \& [TestInterfaceWithTypeParameter](/test-suite-a/testinterfacewithtypeparameter-interface/)\<number\>
**Return type**: [TestEmptyInterface](/test-suite-a/testemptyinterface-interface/) \& [TestInterfaceWithTypeParameter](/test-suite-a/testinterfacewithtypeparameter-interface/)\<number>
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# testFunctionReturningUnionType

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [testFunctionReturningUnionType()](/test-suite-a/testfunctionreturninguniontype-function)
[Packages](/) > [test-suite-a](/test-suite-a/) > [testFunctionReturningUnionType()](/test-suite-a/testfunctionreturninguniontype-function)

Test function that returns an inline type

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# (event: 'testCallSignature', listener: (input: unknown) =\> void): any
# (event: 'testCallSignature', listener: (input: unknown) => void): any

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestInterface](/test-suite-a/testinterface-interface/) \> [(event: 'testCallSignature', listener: (input: unknown) =\> void): any](/test-suite-a/testinterface-interface/_call_-callsignature)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestInterface](/test-suite-a/testinterface-interface/) > [(event: 'testCallSignature', listener: (input: unknown) => void): any](/test-suite-a/testinterface-interface/_call_-callsignature)

Test interface event call signature

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# (event: 'anotherTestCallSignature', listener: (input: number) =\> string): number
# (event: 'anotherTestCallSignature', listener: (input: number) => string): number

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestInterface](/test-suite-a/testinterface-interface/) \> [(event: 'anotherTestCallSignature', listener: (input: number) =\> string): number](/test-suite-a/testinterface-interface/_call__1-callsignature)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestInterface](/test-suite-a/testinterface-interface/) > [(event: 'anotherTestCallSignature', listener: (input: number) => string): number](/test-suite-a/testinterface-interface/_call__1-callsignature)

Another example call signature

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# new (): TestInterface

[Packages](/) \> [test-suite-a](/test-suite-a/) \> [TestInterface](/test-suite-a/testinterface-interface/) \> [new (): TestInterface](/test-suite-a/testinterface-interface/_new_-constructsignature)
[Packages](/) > [test-suite-a](/test-suite-a/) > [TestInterface](/test-suite-a/testinterface-interface/) > [new (): TestInterface](/test-suite-a/testinterface-interface/_new_-constructsignature)

Test construct signature.

Loading
Oops, something went wrong.
Loading
Oops, something went wrong.