pkgsite for Mac 版
Go 包的文档服务器
pkgsite 是什么
这个仓库托管了 pkg.go.dev 网站的源码,以及 pkgsite 这个文档服务器程序。pkg.go.dev 是一个用于发现和评估 Go 包与模块的网站,开发者可以在这里浏览、检索和判断某个 Go 包是否适合自己使用。pkgsite 则负责从 Go 项目中提取并生成文档,可以理解为支撑这类文档浏览体验的服务端工具。
除了网站本身,pkgsite 还提供了一套 REST API,用于获取包和模块信息。接口覆盖的范围包括:查询指定路径的包或模块详情、列出模块版本、获取模块下的包信息、搜索、查看包内符号列表、查询某个包被哪些包导入,以及查看模块的漏洞信息。需要了解参数和响应结构的细节,可以访问 /api 页面或直接查阅 internal/api/api.go 中的源码注释。
这个项目适合需要查阅 Go 包文档的开发者,也适合希望自建文档服务、或通过 API 获取 Go 生态包信息的人。如果想反馈问题或参与贡献,可以先查看已知问题列表,再决定是否提交新 issue;贡献指南和代码仓库地址在 README 中也有说明。
除了网站本身,pkgsite 还提供了一套 REST API,用于获取包和模块信息。接口覆盖的范围包括:查询指定路径的包或模块详情、列出模块版本、获取模块下的包信息、搜索、查看包内符号列表、查询某个包被哪些包导入,以及查看模块的漏洞信息。需要了解参数和响应结构的细节,可以访问 /api 页面或直接查阅 internal/api/api.go 中的源码注释。
这个项目适合需要查阅 Go 包文档的开发者,也适合希望自建文档服务、或通过 API 获取 Go 生态包信息的人。如果想反馈问题或参与贡献,可以先查看已知问题列表,再决定是否提交新 issue;贡献指南和代码仓库地址在 README 中也有说明。
如何安装 pkgsite
- 打开 终端(按 ⌘ + 空格,输入“终端”)。
- 如果还没安装 Homebrew,先运行下面这条安装命令。
- 运行下面这条命令:
最近 10 个版本记录
该项目暂未在 GitHub 发布 Release。
与同类应用对比
只对比公开元数据,不做主观推荐;需要逐项对比时见对比页。
| 应用 | 版本 | 许可证 | 架构 | 近 30 天安装 |
|---|---|---|---|---|
| pkgsite | 0.6.0 | BSD-3-Clause | 命令行 | 9 |
| cweb | cweb-4.12.2 | Knuth-CTAN | 命令行 | 9 |
| goctl | tools/goctl/v1.10.2 | MIT | 命令行 | 9 |
| doc8 | v2.0.0 | Apache-2.0 | 命令行 | 8 |
命令行工具中的类似应用
cweb
cweb 是 Donald Knuth 开发的文学编程工具 CWEB 的持续开发版本。goctl
go-zero 是一个内置大量工程实践的 Web 和 RPC 框架,已入选 CNCF Landscape。doc8
doc8 是一个针对 reStructuredText(并对纯文本提供基础支持)的文档风格检查工具,由 PyCQA 维护。haraka
Haraka 是一个用 Node.js 编写的开源 SMTP 服务器,主打快速、可扩展和事件驱动。openssl@4
OpenSSL 是一套开源、商用级、功能完整的加密工具箱,主要服务于 TLS(早期称 SSL)、DTLS 和 QUIC 协议。xz
XZ Utils 是一个通用数据压缩库,同时附带命令行工具。它的原生格式是 .xz,也兼容旧的 .lzma 格式。所属分类:命令行工具