Open dixler opened 2 years ago
An alternative would be to change the default javadoc doclet to a markdown docklet.
fix this:
@Zaid-Ajaj mentions a workaround here by installing an extension. I wonder if we could link it up that'd be great (unless there is a better fix).
Possible workaround: do not emit codeblocks at all but emit links to them on the docs site (if that's more foolproof to display in IDE).
NOTES: markdown parsers in Golang that return AST exist (goldmark, etc). Some are used in pulumi/pulumi.
Decided to do the workaround for now and deprioritize the deeper fix.
https://plugins.jetbrains.com/plugin/9840-markdown-doclet-for-idea (from @Zaid-Ajaj )
Hello!
Issue details
The providers autogenerated javadoc is currently using our markdown documentation as-is and it displays poorly.
Affected area/feature