Google Git
Sign in
go / pkgsite

Pkg.go.dev

Clone this repo:

Branches

  1. d4de666 internal/database: allow running db tests under different db name by Jean Barkhuysen · 3 weeks ago master
  2. 1d37c52 internal/sanitizer: allow picture and source elements in readme by Josiah McMenamy · 13 days ago
  3. 01b046e cmd/internal/pkgsite: increase x/pkgsite dependency to CL 687918 by Michael Matloob · 13 days ago
  4. 103fd0f cmd/internal/pkgsite: improve godoc mode search in GOROOT by Michael Matloob · 13 days ago
  5. d4fd061 internal/worker: don't require https index URLs by Jean Barkhuysen · 4 weeks ago

golang.org/x/pkgsite

This repository hosts the source code of the pkg.go.dev website, and pkgsite, a documentation server program.

Go Reference

pkg.go.dev: a site for discovering Go packages

Pkg.go.dev is a website for discovering and evaluating Go packages and modules.

You can check it out at https://pkg.go.dev.

pkgsite: a documentation server

pkgsite program extracts and generates documentation for Go projects.

Example usage:

$ go install golang.org/x/pkgsite/cmd/pkgsite@latest
$ cd myproject
$ pkgsite -open .

For more information, see the pkgsite documentation.

Issues

If you want to report a bug or have a feature suggestion, please first check the known issues to see if your issue is already being discussed. If an issue does not already exist, feel free to file an issue.

For answers to frequently asked questions, see pkg.go.dev/about.

You can also chat with us on the #pkgsite Slack channel on the Gophers Slack.

Contributing

We would love your help!

Our canonical Git repository is located at go.googlesource.com/pkgsite. There is a mirror of the repository at github.com/golang/pkgsite.

To contribute, please read our contributing guide.

License

Unless otherwise noted, the Go source files are distributed under the BSD-style license found in the LICENSE file.

Links