https://github.com/longbridge/portai-docs
https://github.com/longbridge/portai-docs
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/longbridge/portai-docs
- Owner: longbridge
- Created: 2025-11-25T09:01:00.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2026-01-21T02:14:09.000Z (5 months ago)
- Last Synced: 2026-01-21T13:47:36.947Z (5 months ago)
- Size: 247 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PortAI Docs
基于 Bun 和 VitePress 构建的现代化文档站点。
## ✨ 特性
- 🚀 **极速开发** - 使用 Bun 作为运行时，享受极致的开发体验
- ⚡️ **快速构建** - 基于 Vite 的超快热更新和优化构建
- 📝 **Markdown 驱动** - 专注于内容创作，使用 Markdown 编写文档
- 🎨 **主题美观** - 现代化、响应式的用户界面
- 🔍 **内置搜索** - 开箱即用的全文搜索功能
- 🌐 **国际化支持** - 支持英文、简体中文、繁体中文三种语言
## 📋 前置要求
- [Bun](https://bun.sh) >= 1.0.0
- Node.js >= 18.0.0（可选）
## 🚀 快速开始
### 安装依赖
```bash
bun install
```
### 本地开发
启动开发服务器，支持热重载：
```bash
bun run docs:dev
```
访问 `http://localhost:5173` 查看文档站点。
### 构建生产版本
```bash
bun run docs:build
```
构建产物将生成在 `docs/.vitepress/dist` 目录。
### 预览生产构建
```bash
bun run docs:preview
```
## 📁 项目结构
```
portai-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
```
## 📝 编写文档
### 创建新页面
1. 在 `docs/` 目录下创建新的 `.md` 文件
2. 在 `docs/.vitepress/config.mts` 中添加导航或侧边栏配置
3. 使用 Markdown 语法编写内容
### Markdown 扩展
VitePress 支持丰富的 Markdown 扩展：
```markdown
::: info
这是一个信息提示框
:::
::: tip
这是一个提示框
:::
::: warning
这是一个警告框
:::
::: danger
这是一个危险警告框
:::
```
### 代码块
支持语法高亮和行号：
````markdown
```typescript
function hello(name: string) {
console.log(`Hello, ${name}!`)
}
```
````
## 🚀 部署
### Vercel（推荐）
1. 将代码推送到 GitHub
2. 在 Vercel 导入仓库
3. 配置构建设置：
- **Build Command**: `bun run docs:build`
- **Output Directory**: `docs/.vitepress/dist`
- **Install Command**: `bun install`
### Netlify
1. 将代码推送到 GitHub
2. 在 Netlify 导入仓库
3. 配置构建设置：
- **Build command**: `bun run docs:build`
- **Publish directory**: `docs/.vitepress/dist`
### GitHub Pages
使用 GitHub Actions 自动部署，参考 `docs/guide/deployment.md` 中的详细说明。
## 🌐 多语言支持
本项目支持三种语言：
- **English** (默认) - `/`
- **简体中文** - `/zh-CN/`
- **繁體中文** - `/zh-HK/`
### 添加新语言
1. 在 `docs/` 下创建新的语言目录（如 `ja/` 用于日语）
2. 复制文档结构到新目录
3. 在 `docs/.vitepress/config.mts` 中添加语言配置：
```typescript
locales: {
// ...existing locales
'ja': {
label: '日本語',
lang: 'ja',
themeConfig: {
nav: [...],
sidebar: [...]
}
}
}
```
## 🛠️ 配置
主要配置文件位于 `docs/.vitepress/config.mts`，您可以自定义：
- 站点标题和描述
- 导航栏和侧边栏
- 多语言配置
- 主题颜色和样式
- 搜索功能
- 社交链接
- 更多...
详细配置说明请查看 [配置文档](docs/guide/configuration.md)。
## 📚 文档
- [快速开始](docs/guide/getting-started.md) - 了解如何使用本项目
- [配置说明](docs/guide/configuration.md) - 自定义您的文档站点
- [部署指南](docs/guide/deployment.md) - 将文档部署到生产环境
- [API 参考](docs/api/introduction.md) - API 文档示例
## 🤝 贡献
欢迎贡献！请随时提交 Issue 或 Pull Request。
## 📄 许可证
[MIT](LICENSE)
## 🔗 相关链接
- [VitePress 官方文档](https://vitepress.dev)
- [Bun 官方文档](https://bun.sh/docs)
- [Markdown 语法指南](https://www.markdownguide.org/)
---
使用 ❤️ 和 [Bun](https://bun.sh) + [VitePress](https://vitepress.dev) 构建