Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
x/pkgsite: README.md shows non-breaking space and non-breaking hyphen as and ‑ strings #37394
This makes correct text look like it has typos when viewed by prospective employers, etc. on go.dev.
GitHub doesn't have any problems and you can see the difference in the screenshots.
Here's a screenshot from go.dev, from github.com, and the markdown code.
What did you see? (go.dev screenshot)
Problems in the screenshot include:
What did you expect to see? (github.com screenshot)
Reproducer (markdown snippet)
This is from fxamacker/cbor. The
Replaced a handful of markdown tables with SVG: "cbor speed/memory comparison", "cbor security comparison", "cbor features" and one more. There's a lot of markdown tables remaining (encoding/decoding option tables, etc.) that are being rendered incorrectly on go.dev. Mentioned the bug fix for v2.2, and CBOR decoder settings: `MaxNestedLevels`, `MaxArrayElements`, `MaxMapPairs`, and `IndefLength`. go.dev bugs filed about this are: golang/go#37284 golang/go#37394 Closes #175
Julie, I appreciate your reply and your work trying to fix this.
I'm just sharing this with you in case there's anyone on your team that's under the impression there's a workaround available.
There is no workaround for this issue and #37284 because go.dev shows all past releases.
I don't think there's anything maintainers can do to make fxamacker/cbor v2.2.0 and prior versions render correctly on go.dev. All maintainers can do is continue converting a dozen markdown tables to svg, and etc. so that v2.3.0 can look nice on go.dev.
I hope you're having a great day and know that lots of people outside of Google also appreciate & value your work!
@x448 - Thanks for the feedback, and I am happy to hear that you are enjoying using pkg.go.dev!
I understand the README issues have been frustrating - I have a fix in review for #37284, which I hope to have live next week, and am currently looking into this issue.
We are also working towards open sourcing the site (https://groups.google.com/g/golang-dev/c/mfiPCtJ1BGU/m/OZ9cU3SgBgAJ), so that in the future we can accept contributions for issues like this.
I'll update this issue once the fix has been merged, and also when it is live on the site. Thanks for being patient, and hope this helps!
Hey Julie, this is fantastic news! Thanks so much for letting me know and sharing as much info as you did! I think @fxamacker and others will appreciate it as well.
Open sourcing pkg.go.dev is a really great decision. I heard a rumor that might be happening so this confirmation is really nice. Revenue generating features could simply build on top of it so it's smart.
Thanks again for coming to the rescue on the two issues. Seeing dmitshur give you a thumbs up on your comment made me happy too. Have a fantastic weekend!
Hi! I discovered this problem is not limited to tables.
This can be seen by bringing up the README of fxamacker/cbor v2.1.0 (not latest version) on go.dev and searching for nbsp (it's in the Comparisons section).
FYI - (you probably know about this) GitHub Flavored Markdown Spec highlights where they differ from regular markdown and also includes 650+ examples/tests.
Julie's fix for #37284 not only worked but it's is beautiful!