Pkg.go.dev

Clone this repo:

Branches

  1. 00698da internal/frontend: replace bluemonday with the simple sanitizer by Michael Matloob · 4 days ago master
  2. a7abb35 internal/sanitizer: be more flexible with what we allow by Michael Matloob · 5 days ago
  3. 691780b internal/frontend: write version of ProcessReadme with rsc.io/markdown by Michael Matloob · 9 days ago
  4. 47bf8d7 internal/sanitizer: address jba's comments on CL 543858 by Michael Matloob · 10 days ago
  5. cd7aa4a internal/sanitizer: keep sanitized child nodes of rejected nodes by Michael Matloob · 12 days 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.

Requirements

Pkgsite requires Go 1.19 to run. The last commit that works with Go 1.18 is 9ffe8b928e4fbd3ff7dcf984254629a47f8b6e63. The last commit that works with Go 1.17 is 4d836c6a652cde92f433967680dfd6171a91ec12.

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