Add mkdocs documentations
This commit is contained in:
59
docs/content/getting-started.md
Normal file
59
docs/content/getting-started.md
Normal file
@@ -0,0 +1,59 @@
|
||||
# 快速开始
|
||||
|
||||
## 环境准备
|
||||
|
||||
### 前置条件
|
||||
|
||||
| 软件 | 版本要求 |
|
||||
|------|---------|
|
||||
| Node.js | 18.0 或更高 |
|
||||
| npm/yarn/pnpm | 最新版本 |
|
||||
| 现代浏览器 | Chrome 90+ / Firefox 90+ / Edge 90+ |
|
||||
|
||||
### 检查环境
|
||||
|
||||
```bash
|
||||
node --version
|
||||
npm --version
|
||||
```
|
||||
|
||||
## 安装步骤
|
||||
|
||||
### 1. 克隆项目
|
||||
|
||||
```bash
|
||||
git clone https://github.com/your-repo/AI-VideoAssistant.git
|
||||
cd AI-VideoAssistant
|
||||
```
|
||||
|
||||
### 2. 安装依赖
|
||||
|
||||
```bash
|
||||
cd web
|
||||
npm install
|
||||
```
|
||||
|
||||
### 3. 配置环境变量
|
||||
|
||||
创建 `.env` 文件:
|
||||
|
||||
```env
|
||||
VITE_API_URL=http://localhost:8080
|
||||
VITE_GEMINI_API_KEY=your_api_key_here
|
||||
```
|
||||
|
||||
### 4. 启动开发服务器
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
访问 http://localhost:3000
|
||||
|
||||
## 构建生产版本
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
构建产物在 `dist` 目录。
|
||||
Reference in New Issue
Block a user