x/pkgsite: consider moving to goldmark to handle issues in READMEs #39297
What is the URL of the page with the issue?
What is your user agent?
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.138 Safari/537.36
Some images don't show up and there is also a markdown table that's screwed up.
The text was updated successfully, but these errors were encountered:
The broken markdown tables for both packages (pdfcpu and parquet-go) seem to be caused by incorrectly formatted markdown, at least according to blackfriday (the external markdown parser pkg.go.dev uses). Note that Github-flavored-markdown (GFM), which Github uses, is not the same as regular markdown.
I tried the above cases using goldmark, and in both cases, the table was identified and rendered properly by goldmark.
I think this, along with active maintenance (last commit was 6 days ago) and broader use among other Go projects, makes moving to goldmark a good idea.
Code in motion. Preparing to generate new readme styles for the goldmark parser. For golang/go#39297 Change-Id: I506046ba36fdef6fa935b0600e1037e2d832ad24 Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/266579 Trust: Jamal Carvalho <email@example.com> Reviewed-by: Julie Qiu <firstname.lastname@example.org>
… code The overview file contains mostly legacy code used to construct the overview page. This change separates the goldmark code in preparation for updates that will generate a TOC for the readme and the future removal of all overview related code. For golang/go#39297 Change-Id: Ifa5d0ee3983478fd25c6c59fc1bd2c45457cc05c Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/267117 Run-TryBot: Jamal Carvalho <email@example.com> TryBot-Result: kokoro <firstname.lastname@example.org> Reviewed-by: Jonathan Amsterdam <email@example.com> Trust: Jamal Carvalho <firstname.lastname@example.org>