Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

x/pkgsite: markdown is broken in my readme.md #40607

Closed
rogercarter1 opened this issue Aug 6, 2020 · 3 comments
Closed

x/pkgsite: markdown is broken in my readme.md #40607

rogercarter1 opened this issue Aug 6, 2020 · 3 comments
Labels
Milestone

Comments

@rogercarter1
Copy link

@rogercarter1 rogercarter1 commented Aug 6, 2020

What is the URL of the page with the issue?

https://pkg.go.dev/mod/github.com/tachyon-protocol/goVsysSdk@v0.1.0

What is your user agent?

Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4222.0 Safari/537.36

Screenshot

Screen Shot 2020-08-06 at 3 21 25 PM

What did you do?

  • write golang example code with ``` in my readme.md

What did you expect to see?

What did you see instead?

  • markdown is broken
@gopherbot gopherbot added this to the Unreleased milestone Aug 6, 2020
@toothrot toothrot added the pkgsite label Aug 7, 2020
@toothrot
Copy link
Contributor

@toothrot toothrot commented Aug 7, 2020

@shaqque
Copy link
Contributor

@shaqque shaqque commented Aug 8, 2020

This is related to #39297. In particular, the README in https://pkg.go.dev/mod/github.com/tachyon-protocol/goVsysSdk@v0.1.0 doesn't have a space/newline before the fenced code block, causing blackfriday to not detect this as a code block.

Using the same code I posted in the linked issue above with minor tweaks, I managed to confirm that this is indeed the case, and that adding a newline before the fenced code block will allow blackfriday to correctly detect and render the code block. I also tried using goldmark on the readme without adding the space/newline before the code block, and goldmark still correctly identified and rendered the code block.

@julieqiu
Copy link
Contributor

@julieqiu julieqiu commented Aug 13, 2020

Closing as a duplicate of #39297.

@julieqiu julieqiu closed this Aug 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
5 participants