You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Sometimes, the generated Markdown has a closing HTML tag followed by text, without any blank lines in-between. This can mess up some Markdown engines, including GitHub and VSCode.
Repro steps
Given the following .d.ts code
/** * Adds two numbers. * @param a - The first number. * @param b - The second number. * @returns The sum. * * @public */exportdeclarefunctionadd(a: number,b: number): number;
running
> api-extractor run
> api-documenter markdown
results in
## Parameters
<table><thead><tr><th>
<!-- ... -->
</tbody></table>
**Returns:**
number
The sum.
Since **Returns:** follows immediately after an HTML tag, it is not rendered properly.
VSCode:
Details
This issue appears with pretty much any function with parameters. It can be fixed by adding a blank line.
Summary
Sometimes, the generated Markdown has a closing HTML tag followed by text, without any blank lines in-between. This can mess up some Markdown engines, including GitHub and VSCode.
Repro steps
Given the following
.d.ts
coderunning
results in
Since
**Returns:**
follows immediately after an HTML tag, it is not rendered properly.VSCode:
Details
This issue appears with pretty much any function with parameters. It can be fixed by adding a blank line.
Relevant issue: microsoft/vscode-markdown-tm-grammar#85
Standard questions
Please answer these questions to help us investigate your issue more quickly:
@microsoft/api-documenter
version?node -v
)?The text was updated successfully, but these errors were encountered: