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 illustrations to documentation pages #39513

Open
ajstarks opened this issue Jun 10, 2020 · 1 comment
Open

x/pkgsite: add illustrations to documentation pages #39513

ajstarks opened this issue Jun 10, 2020 · 1 comment

Comments

@ajstarks
Copy link
Contributor

@ajstarks ajstarks commented Jun 10, 2020

What is the URL of the page with the issue?

Any API documentation URL (for example: https://pkg.go.dev/gioui.org/layout?tab=doc)

What is your user agent?

Mozilla/5.0 (X11; Fedora; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.97 Safari/537.36

What did you expect to see?

I would like to support adding illustrations to documentation pages. Perhaps one method would be to show an image triggered by a magic comment:

// Foo does ....
//  ![foo illustration](link-to-image.png)
func Foo(....) 
 



@gopherbot gopherbot added the pkgsite label Jun 10, 2020
@gopherbot gopherbot added this to the Unreleased milestone Jun 10, 2020
@dmitshur
Copy link
Member

@dmitshur dmitshur commented Jun 11, 2020

Also see #16666.

@julieqiu julieqiu changed the title go.dev: Feature request: add illustrations to documentation pages go.dev: add illustrations to documentation pages Jun 12, 2020
@julieqiu julieqiu changed the title go.dev: add illustrations to documentation pages x/pkgsite: add illustrations to documentation pages Jun 15, 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
4 participants
You can’t perform that action at this time.