fix(typedoc): add spaces in generics to prevent markdown HTML parsing#113
Merged
Merged
Conversation
Added spaces inside angle brackets for generic types (e.g., `< Type >`). This standard workaround prevents markdown parsers (remark from doc-kit) from falsely interpreting these types as raw HTML tags and stripping them from the AST.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Member
|
is this blocked by nodejs/doc-kit#814? |
Contributor
Author
|
This PR result is |
avivkeller
approved these changes
May 31, 2026
avivkeller
left a comment
avivkeller
left a comment
Member
There was a problem hiding this comment.
As long as doc-kit is fine parsing the spaces, and it doesn't interfere, LGTM
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added spaces inside angle brackets for generic types (e.g.,
< Type >), and thedoc-kitwill remove them. This standard workaround prevents markdown parsers (remark fromdoc-kit) from falsely interpreting these types as raw HTML tags and stripping them from the AST.Before:
After:
