Skip to content
On this page


goldmark is a nice markdown parser in Go.


  • You can use relative paths in markdown links.
  • Don't add extra space after heading as it is unnecessary.
  • In referencing titles to jump to in readme, lowercase them. i.e. [Contributing](#contributing). Lose the punctuation in the end in the link.
  • Can use <details> & <summary> to make readmes more readable & hiding info behind a clickable dropdown. (Example) (Example 2)