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: add support for syntax highlighting of code blocks #40952

Open
codyoss opened this issue Aug 21, 2020 · 4 comments
Open

x/pkgsite: add support for syntax highlighting of code blocks #40952

codyoss opened this issue Aug 21, 2020 · 4 comments
Labels
NeedsInvestigation pkgsite UX

Comments

@codyoss
Copy link
Member

@codyoss codyoss commented Aug 21, 2020

What is the URL of the page with the issue?

Any containing code blocks. Example: https://pkg.go.dev/cloud.google.com/go/storage?tab=doc#hdr-Objects

What is your user agent?

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

Screenshot

Screen Shot 2020-08-21 at 9 42 20 AM

What did you do?

Navigate to the page.

What did you expect to see?

Code blocks with syntax highlighting.

What did you see instead?

Code blocks as plain text.

@gopherbot gopherbot added this to the Unreleased milestone Aug 21, 2020
@julieqiu julieqiu added pkgsite NeedsInvestigation UX labels Aug 21, 2020
@julieqiu
Copy link
Contributor

@julieqiu julieqiu commented Aug 21, 2020

Thanks for the suggestion, @codyoss!

/cc @spf13 @Joanne881107 @fflewddur for product / UX input

@dmitshur
Copy link
Contributor

@dmitshur dmitshur commented Aug 21, 2020

Note that there also exist some preformated text blocks that don't contain Go code. For example:

image

(Source: https://pkg.go.dev/cmd/asm#hdr-Command_Line)

@codyoss
Copy link
Member Author

@codyoss codyoss commented Aug 21, 2020

Note that there also exist some preformated text blocks that don't contain Go code

That is a very good point I had not thought of... Might make this quite tricky(infeasible?) as there is no way today to call out what is contained in the block.(i.e. the way markdown supports "```go")

@julieqiu julieqiu removed this from the Unreleased milestone Aug 27, 2020
@julieqiu julieqiu added this to the pkgsite/unreleased milestone Aug 27, 2020
@julieqiu julieqiu removed the website label Sep 19, 2020
@julieqiu julieqiu removed the website label Sep 19, 2020
@Groxx
Copy link

@Groxx Groxx commented Jan 5, 2022

While I would also like this: maybe it's a better fit for a generic syntax highlighter browser plugin? Without code blocks it does seem pretty hard / flaky / possibly frustrating to try to guess and highlight with built-in behavior.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NeedsInvestigation pkgsite UX
Projects
None yet
Development

No branches or pull requests

5 participants