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

Lia*_*lly 3 go godoc go-get

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

由于这些原因,我希望切换到pkg.go.dev在本地使用来查看和创建小型内部包的文档。主要问题是,godoc似乎没有明确的使用指南。我也不知道pkpg.go.dev这项任务是否完全矫枉过正。所以我想知道:

  1. 可以并且应该pkg.go.dev用作本地godoc替代品吗?
  2. 如果是,我将如何运行它来执行此任务?

小智 7

在本地运行 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