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
Hi, I've noticed that, when generating markdown files with some characters like "*(){}[]-", the output is not correct and backslashes are added to the md file before each of the characters. See example below:
Source comment:
// **param** c (context.Context): Execution context
Hi @manlopes, this tool is intentionally aligned with the golang documentation syntax for doc comments, not markdown. This is to maintain consistency with the pkg.go.dev experience and avoid generating documentation that only renders correctly in one place or the other. As a result, markdown-specific syntax like ** for bold items is intentionally escaped as we don't want things being implicitly interpreted as markdown.
If there are other specific rendering bugs that you've found, please feel free to reactivate this issue. I hope that description helped.
Hi, I've noticed that, when generating markdown files with some characters like "*(){}[]-", the output is not correct and backslashes are added to the md file before each of the characters. See example below:
Source comment:
// **param** c (context.Context): Execution context
markdown output
\*\*param\*\* ctx \(context.Context\): Execution context
This issue is similar to issue #68
The text was updated successfully, but these errors were encountered: