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
Incorrect handling of the @
symbol in the preformatted text.
#1218
Incorrect handling of the @
symbol in the preformatted text.
#1218
Comments
That works because importing files happens after parsing for tags. Workaround: Use backtick code fences instead of indentation for code blocks. We do have correct handling for fenced code blocks - https://github.com/TypeStrong/typedoc/blob/master/src/lib/converter/factories/comment.ts#L191 |
Thanks for the info! |
Worked well. I guess I'll keep this issue opened for the info can be discovered by others. |
The fix I put in for this is utterly insufficient.... it assumes everything indented with 4 spaces is code.... which isn't valid if you have a list and put some text on the next line. /**
* Text
* - List item
* - Another list item
* This isn't code, but TypeDoc thinks it is
*/ With 0.23, I plan to drop support for indentation based code blocks in TypeDoc's parser. This matches with how TSDoc plans to handle code blocks, and how the vast majority of code is included in the wild (at least based on my manual polling of several projects). Markdown is an incredibly complex language. Trying to support all of these edge cases seems like a bad idea. |
If the preformatted text in the docs includes
@
symbol (commonly used in decorators):The generated docs looks like this:
The text was updated successfully, but these errors were encountered: