Skip to content

Commit 267bbf7

Browse files
wutongciwutongci
committed
feat: add documentation system with Docus framework
- Add complete documentation structure with 25+ markdown files - Add introduction, user guide, provider configs, API reference - Add troubleshooting and development guides - Add disclaimer for legal use - Add GitHub Actions workflow for auto-deploying docs to GitHub Pages - Bump version to v0.11.0
1 parent 117085e commit 267bbf7

40 files changed

Lines changed: 4879 additions & 4 deletions

‎.github/workflows/deploy-docs.yml‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# 部署文档站点到 GitHub Pages
2+
name: Deploy Docs to Pages
3+
4+
# 触发条件
5+
on:
6+
# 推送到 main 分支且 docs 目录有变更时触发
7+
push:
8+
branches: [main]
9+
paths:
10+
- "docs/**"
11+
12+
# PR 到 main 分支且 docs 目录有变更时触发（仅构建，不部署）
13+
pull_request:
14+
branches: [main]
15+
paths:
16+
- "docs/**"
17+
18+
# 允许手动触发
19+
workflow_dispatch:
20+
21+
# 设置 GitHub Pages 部署所需的权限
22+
permissions:
23+
contents: read
24+
pages: write
25+
id-token: write
26+
27+
# 只允许一个并发部署
28+
concurrency:
29+
group: pages
30+
cancel-in-progress: false
31+
32+
jobs:
33+
# 构建任务
34+
build:
35+
runs-on: ubuntu-latest
36+
steps:
37+
- name: Checkout
38+
uses: actions/checkout@v4
39+
with:
40+
fetch-depth: 0
41+
42+
- name: Setup Node.js
43+
uses: actions/setup-node@v4
44+
with:
45+
node-version: "20"
46+
47+
- name: Setup pnpm
48+
uses: pnpm/action-setup@v4
49+
with:
50+
version: 9
51+
52+
- name: Get pnpm store directory
53+
shell: bash
54+
run: |
55+
echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
56+
57+
- name: Setup pnpm cache
58+
uses: actions/cache@v4
59+
with:
60+
path: ${{ env.STORE_PATH }}
61+
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('docs/pnpm-lock.yaml') }}
62+
restore-keys: |
63+
${{ runner.os }}-pnpm-store-
64+
65+
- name: Setup Pages
66+
uses: actions/configure-pages@v5
67+
68+
- name: Install dependencies
69+
run: pnpm install
70+
working-directory: docs
71+
72+
- name: Build
73+
run: pnpm run generate
74+
working-directory: docs
75+
76+
- name: Upload artifact
77+
uses: actions/upload-pages-artifact@v3
78+
with:
79+
path: docs/.output/public
80+
81+
# 部署任务
82+
deploy:
83+
environment:
84+
name: github-pages
85+
url: ${{ steps.deployment.outputs.page_url }}
86+
needs: build
87+
if: github.event_name != 'pull_request'
88+
runs-on: ubuntu-latest
89+
steps:
90+
- name: Deploy to GitHub Pages
91+
id: deployment
92+
uses: actions/deploy-pages@v4

‎docs/app.config.ts‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
export default {
2+
docus: {
3+
title: "ProxyCast",
4+
description: "把你的 AI 客户端额度用到任何地方",
5+
url: "https://aiclientproxy.github.io/proxycast",
6+
7+
image: "/images/logo-banner.svg",
8+
9+
socials: {
10+
github: "aiclientproxy/proxycast",
11+
},
12+
13+
header: {
14+
logo: true,
15+
title: "ProxyCast",
16+
showLinkIcon: true,
17+
},
18+
19+
aside: {
20+
level: 0,
21+
collapsed: false,
22+
exclude: [],
23+
},
24+
25+
footer: {
26+
credits: {
27+
icon: "",
28+
text: "Made with 💜 by ProxyCast Team",
29+
href: "https://github.com/aiclientproxy",
30+
},
31+
textLinks: [
32+
{
33+
text: "GitHub",
34+
href: "https://github.com/aiclientproxy/proxycast",
35+
target: "_blank",
36+
},
37+
],
38+
iconLinks: [],
39+
},
40+
},
41+
};

‎docs/content/01.introduction/1.overview.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
title: 概述
3+
description: ProxyCast 项目介绍和核心价值
4+
navigation:
5+
icon: i-heroicons-home
6+
---
7+
8+
# ProxyCast 概述
9+
10+
ProxyCast 是一款基于 Tauri 2.0 的跨平台桌面应用，让你可以**把 AI 客户端的订阅额度用到任何地方**。
11+
12+
::alert{type="warning"}
13+
**免责声明**: 本工具仅限于个人合法使用，严禁用于非法盈利目的。初衷是帮助用户充分利用已订阅的 AI 服务 Token。[查看完整声明](/legal/disclaimer)
14+
::
15+
16+
## 核心价值
17+
18+
你是否有以下困扰？
19+
20+
- 订阅了 Kiro、Claude Code 等 AI 编程助手，但只能在特定 IDE 中使用
21+
- 想在其他工具（如 Cursor、Continue、自定义脚本）中使用已有的 AI 额度
22+
- 需要管理多个 AI 服务的凭证，频繁切换很麻烦
23+
24+
ProxyCast 解决这些问题：将你的 AI 客户端凭证转换为标准的 OpenAI/Claude 兼容 API，让任何支持 OpenAI 接口的工具都能使用你的订阅额度。
25+
26+
## 支持的 Provider
27+
28+
| Provider | 类型 | 认证方式 | 说明 |
29+
|----------|------|----------|------|
30+
| Kiro Claude | OAuth | 自动刷新 | AWS Kiro IDE 的 Claude 凭证 |
31+
| Gemini CLI | OAuth | 自动刷新 | Google Gemini CLI 凭证 |
32+
| Qwen (通义千问) | OAuth | 自动刷新 | 阿里云通义千问凭证 |
33+
| OpenAI Custom | API Key | 手动配置 | 自定义 OpenAI 兼容服务 |
34+
| Claude Custom | API Key | 手动配置 | 自定义 Claude 兼容服务 |
35+
36+
## 核心特性
37+
38+
### 🔑 凭证池管理
39+
- 支持多个 Provider 凭证的统一管理
40+
- 自动检测和加载本地凭证文件
41+
- OAuth Token 自动刷新机制
42+
43+
### ⚖️ 智能路由
44+
- 基于模型名称的请求路由
45+
- 负载均衡和优先级配置
46+
- 健康检查和自动故障转移
47+
48+
### 🛡️ 容错机制
49+
- 可配置的重试策略
50+
- 超时控制和熔断器
51+
- 多 Provider 故障转移
52+
53+
### 🔄 协议转换
54+
- OpenAI Chat Completions API 兼容
55+
- Claude Messages API 兼容
56+
- 自动格式转换
57+
58+
### 📊 监控统计
59+
- 实时请求统计
60+
- Token 使用追踪
61+
- 详细的请求日志
62+
63+
## 使用场景
64+
65+
1. **IDE 集成**: 在 Cursor、Continue 等编辑器中使用 Kiro/Claude Code 额度
66+
2. **脚本调用**: 在 Python/Node.js 脚本中调用 AI API
67+
3. **多账户管理**: 统一管理多个 AI 服务账户
68+
4. **团队共享**: 通过配置导出分享 Provider 设置
69+
70+
## 下一步
71+
72+
- [安装指南](/introduction/installation) - 下载并安装 ProxyCast
73+
- [快速开始](/introduction/quickstart) - 5 分钟内完成首次 API 调用

‎docs/content/01.introduction/2.installation.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
title: 安装指南
3+
description: 下载并安装 ProxyCast
4+
navigation:
5+
icon: i-heroicons-arrow-down-tray
6+
---
7+
8+
# 安装指南
9+
10+
## 系统要求
11+
12+
| 平台 | 最低版本 | 架构 |
13+
|------|----------|------|
14+
| macOS | 11.0 (Big Sur) | Apple Silicon (arm64) |
15+
| Windows | 10 | x64 |
16+
17+
## 下载
18+
19+
从 GitHub Releases 下载最新版本：
20+
21+
::button-link
22+
---
23+
to: https://github.com/aiclientproxy/proxycast/releases
24+
target: _blank
25+
icon: i-simple-icons-github
26+
---
27+
下载 ProxyCast
28+
::
29+
30+
### 安装包
31+
32+
| 平台 | 文件名 | 说明 |
33+
|------|--------|------|
34+
| macOS | `ProxyCast_x.x.x_aarch64.dmg` | Apple Silicon Mac |
35+
| Windows | `ProxyCast_x.x.x_x64-setup.exe` | Windows 64位 |
36+
37+
## macOS 安装
38+
39+
1. 下载 `.dmg` 文件
40+
2. 双击打开 DMG 镜像
41+
3. 将 ProxyCast 拖入 Applications 文件夹
42+
4. 首次运行时，右键点击应用选择"打开"（绕过 Gatekeeper）
43+
44+
::alert{type="info"}
45+
如果提示"无法验证开发者"，请在系统偏好设置 > 安全性与隐私中点击"仍要打开"。
46+
::
47+
48+
## Windows 安装
49+
50+
1. 下载 `.exe` 安装程序
51+
2. 双击运行安装程序
52+
3. 按照安装向导完成安装
53+
4. 从开始菜单启动 ProxyCast
54+
55+
## 验证安装
56+
57+
启动 ProxyCast 后，你应该看到：
58+
59+
1. 系统托盘图标出现
60+
2. 主窗口显示仪表盘
61+
3. 服务状态显示"已停止"（首次启动）
62+
63+
## 常见安装问题
64+
65+
### macOS: "应用已损坏"
66+
67+
```bash
68+
# 移除隔离属性
69+
xattr -cr /Applications/ProxyCast.app
70+
```
71+
72+
### Windows: SmartScreen 警告
73+
74+
点击"更多信息" > "仍要运行"即可继续安装。
75+
76+
## 下一步
77+
78+
安装完成后，继续阅读 [快速开始](/introduction/quickstart) 配置你的第一个 Provider。

0 commit comments

Comments
 (0)