Skip to content
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

Object details in type description is not escaped #292

Closed
arantes555 opened this issue Feb 14, 2022 · 2 comments
Closed

Object details in type description is not escaped #292

arantes555 opened this issue Feb 14, 2022 · 2 comments

Comments

@arantes555
Copy link

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"; }

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:

{ [id: string]: "ok" | "ko"; }

(plus, it seems more coherent to me, as most other types and variable names are in backquotes)

@tgreyuk
Copy link
Member

tgreyuk commented Feb 14, 2022

fix in typedoc-plugin-markdown@3.11.14

@tgreyuk tgreyuk closed this as completed Feb 14, 2022
@arantes555
Copy link
Author

@tgreyuk as always, thank you for your amazing reactivity! Hat's off to you 🎩

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants