如何在本地运行pkg.go.dev作为godoc的替代方案？

1. pkgsite是否适合替代本地godoc？ #

完全可以，也完全适配本地查看、编写小型内部包文档的需求。
pkgsite本身就支持本地运行模式，除了继承godoc所有的Go文档解析能力外，额外的README渲染、示例代码高亮、依赖展示等功能实用性远高于原godoc。很多人担心的重量问题也不存在，本地空载运行占用内存仅几十MB，普通开发设备运行无任何压力。

2. 本地运行配置步骤 #

前置条件 #

本地已安装Go 1.18及以上版本，且GOPATH/bin已加入系统环境变量PATH。

安装步骤 #

• 执行安装命令：
  go install golang.org/x/pkgsite/cmd/pkgsite@latest

常用运行方式 #

• 全量索引本地包：直接运行pkgsite，默认监听localhost:8080，访问即可查看本地GOPATH、模块缓存中所有包的文档。
• 仅索引当前开发目录：适合编写本地内部包时使用，运行命令：
  pkgsite -gopath_mode=false -watch .
  该模式会监听当前目录下的代码、README变更，刷新页面即可看到最新文档，无需重启服务。
• 自定义监听端口：添加-http参数指定端口，示例如下：
  pkgsite -http :9090

内容的提问来源于stack exchange，提问作者Liam Kelly