x/pkgsite: serve status badge similar to godoc.org

[icza]

What did you do?

It would be nice to have a badge that can be used on other sites (e.g. github.com) that link to the documentation page of the module / package.

For example, using a URL like this:

https://godoc.org/github.com/icza/bitio?status.svg

Serves an image, a badge which is often used on the package's repository to link to the documentation, like this one:

A similar feature like

https://pkg.go.dev/github.com/icza/bitio?status.svg

Would be useful. Some configuration via URL parameters (like size, color etc) would also be cool.

What did you expect to see?

To have a badge image served similar to godoc.org's response.

What did you see instead?

Request is redirected to https://pkg.go.dev/github.com/icza/bitio?tab=doc and the HTML page is served.

[oliverpool]

I just handcrafted a badge on https://shields.io:

[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/url/of/your-module)

Feel free to tweak the parameters to improve it :-)

The resulting svg could be statically saved somewhere on https://pkg.go.dev (since it is not package dependent).

Edit: use flat-square

[integrii]

I was able to get a nice badge for flaggy with the following code in my README.md (inspired from @oliverpool above):

<a href="https://pkg.go.dev/github.com/integrii/flaggy"> <img src="https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white"></a>