如何在本地运行pkg.go.dev作为godoc的替代品?

Question

godoc自1.12以来已从go标准安装中删除，并且看起来不会很快更新。pkg.go.dev至少看起来是它的继承者。它还具有额外的文档功能，如抓取README.md文件并在文档页面中呈现它。

由于这些原因，我希望切换到使用pkg.go.dev本地查看和创建小内部包的文档。主要的问题是，不像godoc，似乎没有一个明确的使用指南。我也不知道pkpg.go.dev对于这个任务来说是否完全是多余的。所以我想知道:

1. pkg.go.dev可以和应该用作本地godoc的替代品吗?
2. 如果是，我该如何为这个任务运行它?

Answer 1

在本地运行pkgsite

go install golang.org/x/pkgsite/cmd/pkgsite@latest && pkgsite

引用:

1. https://tip.golang.org/doc/comment
2. https://pkg.go.dev/golang.org/x/pkgsite/cmd/pkgsite

Answer 2

您可以使用x/tools/godoc，其中包含先前的godoc工具

Answer 3

单独运行godoc[1]对我来说是有效的，但是速度很慢，因为它为标准库中的每个包生成文档，而我只关心我正在处理的本地包。为此，如果您的包位于名为something的文件夹中，您可以移动该文件夹，使其看起来像这样:

godoc/src/something

然后，进入godoc文件夹，运行

godoc -goroot .

然后，浏览到localhost:6060。或者，另一个站点可用于Go docs [2].

1. https://github.com/golang/tools/tree/master/cmd/godoc
2. https://godocs.io