godoc
has been removed from the go standard install since 1.12 and looks like it wont be updated anytime soon. pkg.go.dev
at least appears to be its successor. It also has additional documentation features like grabbing the README.md
file and rendering it in the documentation page.
For these reasons I was hoping to switch over to using pkg.go.dev
locally to view and create documentation for small internal packages. The major issue is that unlike godoc
there does not seem to be a clear usage guide. I also do not know if pkpg.go.dev
is completely overkill for this task. So I would like to know:
pkg.go.dev
be used as a local godoc
replacement?Run pkgsite locally.
go install golang.org/x/pkgsite/cmd/pkgsite@latest && pkgsite
References: