基于 Bun 和 VitePress 构建的现代化文档站点。
- 🚀 极速开发 - 使用 Bun 作为运行时，享受极致的开发体验
- ⚡️ 快速构建 - 基于 Vite 的超快热更新和优化构建
- 📝 Markdown 驱动 - 专注于内容创作，使用 Markdown 编写文档
- 🎨 主题美观 - 现代化、响应式的用户界面
- 🔍 内置搜索 - 开箱即用的全文搜索功能
- 🌐 国际化支持 - 支持英文、简体中文、繁体中文三种语言
- Bun >= 1.0.0
- Node.js >= 18.0.0（可选）
bun install启动开发服务器，支持热重载：
bun run docs:dev访问 http://localhost:5173 查看文档站点。
bun run docs:build构建产物将生成在 docs/.vitepress/dist 目录。
bun run docs:previewportai-docs/
├── docs/ # 文档源文件
│ ├── .vitepress/ # VitePress 配置
│ │ └── config.mts # 站点配置文件
│ ├── guide/ # 英文指南文档
│ │ ├── getting-started.md
│ │ ├── configuration.md
│ │ └── deployment.md
│ ├── api/ # 英文 API 文档
│ │ ├── introduction.md
│ │ └── core.md
│ ├── zh-CN/ # 简体中文文档
│ │ ├── guide/
│ │ ├── api/
│ │ └── index.md
│ ├── zh-HK/ # 繁体中文文档
│ │ ├── guide/
│ │ ├── api/
│ │ └── index.md
│ └── index.md # 英文首页（默认）
├── package.json
└── README.md
- 在
docs/目录下创建新的.md文件 - 在
docs/.vitepress/config.mts中添加导航或侧边栏配置 - 使用 Markdown 语法编写内容
VitePress 支持丰富的 Markdown 扩展：
::: info
这是一个信息提示框
:::
::: tip
这是一个提示框
:::
::: warning
这是一个警告框
:::
::: danger
这是一个危险警告框
:::支持语法高亮和行号：
```typescript
function hello(name: string) {
console.log(`Hello, ${name}!`)
}
```- 将代码推送到 GitHub
- 在 Vercel 导入仓库
- 配置构建设置：
- Build Command:
bun run docs:build - Output Directory:
docs/.vitepress/dist - Install Command:
bun install
- Build Command:
- 将代码推送到 GitHub
- 在 Netlify 导入仓库
- 配置构建设置：
- Build command:
bun run docs:build - Publish directory:
docs/.vitepress/dist
- Build command:
使用 GitHub Actions 自动部署，参考 docs/guide/deployment.md 中的详细说明。
本项目支持三种语言：
- English (默认) -
/ - 简体中文 -
/zh-CN/ - 繁體中文 -
/zh-HK/
- 在
docs/下创建新的语言目录（如ja/用于日语） - 复制文档结构到新目录
- 在
docs/.vitepress/config.mts中添加语言配置：
locales: {
// ...existing locales
'ja': {
label: '日本語',
lang: 'ja',
themeConfig: {
nav: [...],
sidebar: [...]
}
}
}主要配置文件位于 docs/.vitepress/config.mts，您可以自定义：
- 站点标题和描述
- 导航栏和侧边栏
- 多语言配置
- 主题颜色和样式
- 搜索功能
- 社交链接
- 更多...
详细配置说明请查看 配置文档。
欢迎贡献！请随时提交 Issue 或 Pull Request。