pgit

你是否希望：

• 在无网络环境下浏览代码历史？
• 将私有项目以 GitHub 风格展示，无需上传到云端？
• 完全掌控代码展示的样式与内容，而非依赖平台限制？

pgit是一个轻量级的 Git 静态网站生成器，能将你的本地仓库转换为可浏览的 HTML 网站，界面类似 GitHub 的“代码”标签页，支持语法高亮、提交历史、文件树导航，且完全离线、100% 私有。

核心能力：像 GitHub，但属于你

• ✅ 代码浏览：按目录结构查看文件，点击进入单个文件
• ✅ 提交历史：查看每次提交的变更（diff），支持跳转到特定版本
• ✅ 语法高亮：内置多种主题，代码可读性强
• ✅ README 支持：自动提取仓库根目录的 README.md 并嵌入首页
• ✅ 纯静态输出：仅生成 HTML/CSS/JS 文件，可托管于任何静态服务器（包括本地）

所有数据保留在你的设备上，不依赖 GitHub、GitLab 或任何第三方服务。

快速上手：三行命令搞定

git clone git@github.com:picosh/pgit.git
cd pgit
make build

生成的二进制文件 ./pgit 可直接运行：

./pgit

执行后，会在当前目录生成 public/ 文件夹，内含完整的静态网站。
通过本地 Web 服务器即可访问（如 Python 快速启动）：

cd public
python3 -m http.server 8000

然后打开 http://localhost:8000，即可看到你的“私有 GitHub”。

高级用法：多仓库、自定义与性能优化

托管多个仓库

默认 pgit 生成根路径链接，适合单项目。若需共存多个项目，可指定子路径：

pgit --out ./public/project-a --root-relative "/project-a/"
pgit --out ./public/project-b --root-relative "/project-b/"

配合 Apache/Nginx 虚拟主机，即可通过 http://localhost/project-a 和 /project-b 分别访问。

控制生成范围

大型仓库可能生成缓慢。可通过以下参数优化：

• --max-commits 1000：仅处理最近 1000 次提交
• --revs dev,main,v1.0：指定多个分支/标签/提交哈希生成对应视图

自定义外观

• 使用 --theme 切换语法高亮主题
• 修改 html/ 目录下的模板文件，深度定制布局（需重新编译）

为什么选择 pgit？

替代方案对比

对于只需代码浏览的场景，pgit 提供了最轻量、最私密的解决方案。

典型使用场景

• 开发者文档归档：将重要项目的代码历史打包为可离线查阅的文档
• 安全审计：在隔离网络中审查第三方代码库，无需联网
• 教学演示：向学生展示 Git 历史与代码演进，无需依赖外部服务
• 备份展示：将 Git 仓库作为静态网站备份，防止平台宕机导致不可访问