Version: v0.0.0-...-ec5474e Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Aug 9, 2022 License: BSD-3-Clause Imports: 24 Imported by: 0



Pkgsite extracts and generates documentation for Go programs. It runs as a web server and presents the documentation as a web page.

To install, run `go install ./cmd/pkgsite` from the pkgsite repo root.

With no arguments, pkgsite will serve docs for the module in the current directory, which must have a go.mod file:

cd ~/repos/cue && pkgsite

This form will also serve all of the module's required modules at their required versions. You can disable serving the required modules by passing -list=false.

You can also serve docs from your module cache, directly from the proxy (it uses the GOPROXY environment variable), or both:

pkgsite -cache -proxy

With either -cache or -proxy, pkgsite won't look for a module in the current directory. You can still provide modules on the local filesystem by listing their paths:

pkgsite -cache -proxy ~/repos/cue some/other/module

Although standard library packages will work by default, the docs can take a while to appear the first time because the Go repo must be cloned and processed. If you clone the repo yourself (, you can provide its location with the -gorepo flag to save a little time.

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL