https://github.com/golang/pkgsite
[mirror] Home of the pkg.go.dev website
https://github.com/golang/pkgsite
Last synced: 7 months ago
JSON representation
[mirror] Home of the pkg.go.dev website
- Host: GitHub
- URL: https://github.com/golang/pkgsite
- Owner: golang
- License: bsd-3-clause
- Created: 2020-05-19T15:06:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-01T19:03:28.000Z (9 months ago)
- Last Synced: 2025-04-05T11:01:41.807Z (8 months ago)
- Language: Go
- Size: 386 MB
- Stars: 1,260
- Watchers: 42
- Forks: 183
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome - golang/pkgsite - 11 star:1.3k fork:0.2k [mirror] Home of the pkg.go.dev website (Go)
README
# golang.org/x/pkgsite
This repository hosts the source code of the [pkg.go.dev](https://pkg.go.dev) website,
and [`pkgsite`](https://pkg.go.dev/golang.org/x/pkgsite/cmd/pkgsite), a documentation
server program.
[](https://pkg.go.dev/golang.org/x/pkgsite)
## 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](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](https://pkg.go.dev/golang.org/x/pkgsite/cmd/pkgsite).
## Issues
If you want to report a bug or have a feature suggestion, please first check
the [known issues](https://github.com/golang/go/labels/pkgsite) to see if your
issue is already being discussed. If an issue does not already exist, feel free
to [file an issue](https://golang.org/s/pkgsite-feedback).
For answers to frequently asked questions, see [pkg.go.dev/about](https://pkg.go.dev/about).
You can also chat with us on the
[#pkgsite Slack channel](https://gophers.slack.com/archives/C0166L4QGJV) on the
[Gophers Slack](https://invite.slack.golangbridge.org).
## Contributing
We would love your help!
Our canonical Git repository is located at
[go.googlesource.com/pkgsite](https://go.googlesource.com/pkgsite).
There is a mirror of the repository at
[github.com/golang/pkgsite](https://github.com/golang/pkgsite).
To contribute, please read our [contributing guide](CONTRIBUTING.md).
## License
Unless otherwise noted, the Go source files are distributed under the BSD-style
license found in the [LICENSE](LICENSE) file.
## Links
- [Homepage](https://pkg.go.dev)
- [Feedback](https://golang.org/s/pkgsite-feedback)
- [Issue Tracker](https://golang.org/s/pkgsite-issues)