Pi 文档网站

这是 Pi 编码助手的中文文档网站，基于 VitePress 构建。

特性

• ✅ 完整的中文文档翻译
• ✅ 明亮主题设计（支持暗色模式切换）
• ✅ 本地搜索支持
• ✅ 响应式布局
• ✅ 快速的页面加载

开发

安装依赖

npm install

启动开发服务器

npm run dev

访问 http://localhost:5173 查看网站。

构建生产版本

npm run build

构建输出在 .vitepress/dist 目录。

预览生产构建

npm run preview

项目结构

pi-docs-website/
├── .vitepress/          # VitePress 配置
│   ├── config.mts       # 站点配置
│   └── theme/           # 自定义主题
│       ├── index.js     # 主题入口
│       └── custom.css   # 自定义样式
├── public/              # 静态资源
│   ├── logo.svg         # Logo 文件
│   └── images/          # 文档图片
├── *.md                 # 文档页面
├── package.json         # 项目配置
└── README.md            # 本文件

文档来源

所有文档翻译自 Pi 编码助手官方文档： @earendil-works/pi-coding-agent/docs

文档更新

当需要更新文档时：

1. 从官方文档复制最新的 .md 文件
2. 翻译新增或修改的内容
3. 确保所有链接格式正确（使用 /path 格式）
4. 测试本地预览

部署

静态托管

构建后的文件可以部署到任何静态托管服务：

• Vercel
• Netlify
• GitHub Pages
• Cloudflare Pages
• 等等

GitHub Pages 部署示例

# 构建
npm run build

# 部署到 gh-pages 分支
cd .vitepress/dist
git init
git add -A
git commit -m 'deploy'
git push -f git@github.com:username/pi-docs-cn.git main:gh-pages

贡献

欢迎提交 Issue 和 Pull Request 来改进文档翻译质量。

许可

文档内容遵循原始 Pi 项目的许可证。