We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Introduced in #286 (comment)
typedoc-plugin-markdown now puts object details in type description tables. The problem is with objects of the form :
{ [id: string]: "ok" | "ko"; }
"ok"
"ko"
The [id: string] part is interpreted as a link by some markdown parsers (examples : WebStorm, and check-md : https://github.com/whxaxes/check-md).
[id: string]
Solution: wrap it in backquotes:
(plus, it seems more coherent to me, as most other types and variable names are in backquotes)
The text was updated successfully, but these errors were encountered:
fix: wrap index signature output within back ticks (#292)
2226322
fix in typedoc-plugin-markdown@3.11.14
Sorry, something went wrong.
@tgreyuk as always, thank you for your amazing reactivity! Hat's off to you 🎩
No branches or pull requests
Introduced in #286 (comment)
typedoc-plugin-markdown now puts object details in type description tables. The problem is with objects of the form :
The
[id: string]
part is interpreted as a link by some markdown parsers (examples : WebStorm, and check-md : https://github.com/whxaxes/check-md).Solution: wrap it in backquotes:
(plus, it seems more coherent to me, as most other types and variable names are in backquotes)
The text was updated successfully, but these errors were encountered: