README
¶
golang.org/x/pkgsite
This repository hosts the source code of the pkg.go.dev website,
and pkgsite, a documentation
server program.
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.
API
pkgsite provides a REST API for retrieving package and module information.
The API endpoints include:
/v1/package/{path}: Information about the package at{path}./v1/module/{path}: Information about the module at{path}./v1/versions/{path}: Versions of the module at{path}./v1/packages/{path}: Information about packages of the module at{path}./v1/search: Search results./v1/symbols/{path}: List of symbols for the package at{path}./v1/imported-by/{path}: Paths of packages importing the package at{path}./v1/vulns/{path}: Vulnerabilities of the module at{path}.
For detailed documentation of parameters and response schemas, see the documentation page served at /api, or refer directly to the annotated source code in internal/api/api.go.
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
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
frontend
command
The frontend runs a service to serve user-facing traffic.
|
The frontend runs a service to serve user-facing traffic. |
|
internal/cmdconfig
Package cmdconfig contains functions for configuring commands.
|
Package cmdconfig contains functions for configuring commands. |
|
internal/pkgsite-cli
command
Command pkgsite-cli queries the pkg.go.dev API for information about Go packages and modules.
|
Command pkgsite-cli queries the pkg.go.dev API for information about Go packages and modules. |
|
internal/pkgsite-cli/client
Package client provides a client for the pkg.go.dev v1 API.
|
Package client provides a client for the pkg.go.dev v1 API. |
|
pkgsite
command
Pkgsite extracts and generates documentation for Go programs.
|
Pkgsite extracts and generates documentation for Go programs. |
|
worker
command
The worker command runs a service with the primary job of fetching modules from a proxy and writing them to the database.
|
The worker command runs a service with the primary job of fetching modules from a proxy and writing them to the database. |
|
internal/doc
module
|
|
|
devtools
|
|
|
cmd/create_experiment_config
command
Command create_experiment_config creates an experiment.yaml file, which will set a rollout of 100 for all experiments.
|
Command create_experiment_config creates an experiment.yaml file, which will set a rollout of 100 for all experiments. |
|
cmd/csphash
command
csphash computes the hashes of script tags in files, and checks that they are added to our content security policy.
|
csphash computes the hashes of script tags in files, and checks that they are added to our content security policy. |
|
cmd/css
command
Command css appends CSS styles to content/static/stylesheet.css.
|
Command css appends CSS styles to content/static/stylesheet.css. |
|
cmd/db
command
The seeddb command is used to populates a database with an initial set of modules.
|
The seeddb command is used to populates a database with an initial set of modules. |
|
cmd/dumpdoc
command
The dumpdoc command writes documentation and readmes for packages in search_documents to a gob file.
|
The dumpdoc command writes documentation and readmes for packages in search_documents to a gob file. |
|
cmd/evaldoc
command
The evaldoc command is an HTTP server that takes a module_path@version or a local directory path, loads the module, and serves:
|
The evaldoc command is an HTTP server that takes a module_path@version or a local directory path, loads the module, and serves: |
|
cmd/seeddb
command
The seeddb command populates a database with an initial set of modules.
|
The seeddb command populates a database with an initial set of modules. |
|
cmd/static
command
Command static compiles TypeScript files into minified JavaScript files and creates linked sourcemaps.
|
Command static compiles TypeScript files into minified JavaScript files and creates linked sourcemaps. |
|
cmd/wait_available
command
|
|
|
Package internal contains data used through x/pkgsite.
|
Package internal contains data used through x/pkgsite. |
|
auth
Package auth authorizes programs to make HTTP requests to the discovery site.
|
Package auth authorizes programs to make HTTP requests to the discovery site. |
|
breakings
Package api finds the API of a package: the set of exported symbols and their types.
|
Package api finds the API of a package: the set of exported symbols and their types. |
|
breakings/tri
Package tri defines a 3-valued bool-like value, tri.Bool.
|
Package tri defines a 3-valued bool-like value, tri.Bool. |
|
browser
Package browser provides utilities for interacting with users' browsers.
|
Package browser provides utilities for interacting with users' browsers. |
|
cache
Package cache implements a redis-based page cache for pkgsite.
|
Package cache implements a redis-based page cache for pkgsite. |
|
config
Package config provides the definition of the configuration for the frontend.
|
Package config provides the definition of the configuration for the frontend. |
|
config/dynconfig
Package dynconfig supports dynamic configuration for pkgsite services.
|
Package dynconfig supports dynamic configuration for pkgsite services. |
|
config/serverconfig
Package serverconfig resolves shared configuration for Go Discovery services.
|
Package serverconfig resolves shared configuration for Go Discovery services. |
|
cookie
Package cookie is used to get and set HTTP cookies.
|
Package cookie is used to get and set HTTP cookies. |
|
database
Package database adds some useful functionality to a sql.DB.
|
Package database adds some useful functionality to a sql.DB. |
|
dcensus
Package dcensus provides functionality for debug instrumentation.
|
Package dcensus provides functionality for debug instrumentation. |
|
derrors
Package derrors defines internal error values to categorize the different types error semantics we support.
|
Package derrors defines internal error values to categorize the different types error semantics we support. |
|
experiment
Package experiment provides functionality for experiments.
|
Package experiment provides functionality for experiments. |
|
fetch
Package fetch provides a way to fetch modules from a proxy.
|
Package fetch provides a way to fetch modules from a proxy. |
|
fetchdatasource
Package fetchdatasource provides an internal.DataSource implementation that fetches modules (rather than reading them from a database).
|
Package fetchdatasource provides an internal.DataSource implementation that fetches modules (rather than reading them from a database). |
|
frontend
Package frontend provides functionality for running the pkg.go.dev site.
|
Package frontend provides functionality for running the pkg.go.dev site. |
|
frontend/client
Package client provides a client for interacting with the frontend.
|
Package client provides a client for interacting with the frontend. |
|
frontend/page
Package page defines common fields shared by pages when rendering templages.
|
Package page defines common fields shared by pages when rendering templages. |
|
frontend/serrors
serrors contains error types used by the server
|
serrors contains error types used by the server |
|
frontend/urlinfo
Package urlinfo provides functions for extracting information out of url paths.
|
Package urlinfo provides functions for extracting information out of url paths. |