Godoc Markdown Not Rendering Correctly

[RobbieMcKinstry]

What happened?

There are a number of instances in the Godoc where the Markdown is not rendering correctly. It looks like virtually every Resource has this issue.

Godoc supports headings with only one "#", not nested headings, which is probably where this issue begins. I'm unsure the code blocks are not accepted.

• Database User
• DNS Record
• Domain
• Droplet
• Droplet Snapshot
• Firewall
• Floating IP
• Floating IP Assignment
• GetAccountResult

This list continues. I'm noticing anything with an Example section breaks the markdown.

Steps to reproduce

1. Visit the godoc page for DO.
2. Ctrl-F for func main and observe that the markdown does not render code blocks correctly. Similarly with import statements.

Expected Behavior

• I expected all code to be contined within codeblocks.
• I expected markdown headers (lines containing # or ## or ###) to render as HTML headings.

Actual Behavior

Some code is in code blocks, and some code isn't, even within a single example program.

Versions used

No response

Additional context

No response

Contributing

Vote on this issue by adding a 👍 reaction. To contribute a fix for this issue, leave a comment (and link to your pull request, if you've opened one already).

[iwahbe]

Hi @RobbieMcKinstry. Thanks for coming back and opening an issue.

Right now, the bridge assumes that markdown is OK to put in all docs for all languages. I know thats not true for Go, nor is it true for Java and probably other languages.