{章节缩写}_{序号}_{描述}.png

示例:
- gs_01_clone_repo.png          # get_started 章节第1张图：克隆仓库
- gs_02_config_apikey.png       # get_started 章节第2张图：配置API KEY
- model_01_openai_apikey.png    # models 章节第1张图：OpenAI API KEY
- feat_arxiv_01_input.png       # features/arxiv 章节第1张图：输入界面

<!-- IMAGE: {图片文件名} -->
<!-- 描述: {图片应展示的内容} -->
<!-- 尺寸建议: {宽度}px -->
![{alt文本}](images/{图片文件名})

docs/
├── index.md                              # 首页
├── images/                               # 所有图片存放目录
│   ├── gs_*.png                          # 快速开始相关图片
│   ├── model_*.png                       # 模型接入相关图片
│   ├── feat_*.png                        # 功能指南相关图片
│   ├── custom_*.png                      # 自定义扩展相关图片
│   ├── deploy_*.png                      # 部署相关图片
│   └── trouble_*.png                     # 问题排查相关图片
│
├── get_started/                          # 快速开始
│   ├── installation.md                   # 安装指南
│   ├── quickstart.md                     # 5分钟快速上手
│   └── configuration.md                  # 配置文件详解
│
├── models/                               # 模型接入
│   ├── overview.md                       # 模型支持概览
│   ├── openai.md                         # OpenAI 接入
│   ├── azure.md                          # Azure OpenAI 接入
│   ├── chinese_models.md                 # 国产模型接入
│   ├── local_models.md                   # 本地模型部署
│   └── custom_models.md                  # 自定义模型开发
│
├── features/                             # 功能指南
│   ├── basic_functions.md                # 基础功能
│   ├── academic/                         # 学术功能
│   │   ├── arxiv_translation.md          # Arxiv论文翻译
│   │   ├── pdf_translation.md            # PDF论文翻译
│   │   ├── latex_polish.md               # Latex项目处理
│   │   ├── paper_reading.md              # 论文阅读助手
│   │   ├── pdf_summary.md                # 批量总结PDF文档 [新增]
│   │   ├── word_summary.md               # 批量总结Word文档 [新增]
│   │   ├── pdf_qa.md                     # PDF问答(ChatPDF) [新增]
│   │   ├── tex_abstract.md               # 读Tex论文写摘要 [新增]
│   │   ├── google_scholar.md             # 谷歌学术检索助手 [新增]
│   │   ├── arxiv_download.md             # Arxiv论文下载与摘要翻译 [新增]
│   │   ├── latex_proofread.md            # Latex英文纠错+高亮对比 [新增]
│   │   ├── pdf_nougat.md                 # PDF精准翻译(NOUGAT) [新增]
│   │   └── batch_file_query.md           # 批量文件询问 [新增]
│   ├── programming/                      # 编程功能
│   │   ├── code_analysis.md              # 源码分析
│   │   ├── code_comment.md               # 代码注释生成
│   │   ├── markdown_translate.md         # Markdown翻译
│   │   ├── jupyter_analysis.md           # Jupyter Notebook分析 [新增]
│   │   ├── custom_code_analysis.md       # 自定义源码分析 [新增]
│   │   └── batch_comment_gen.md          # 批量函数注释生成 [新增]
│   ├── conversation/                     # 对话功能
│   │   ├── internet_search.md            # 联网搜索
│   │   ├── multi_model_query.md          # 多模型询问
│   │   ├── image_generation.md           # 图片生成
│   │   ├── voice_assistant.md            # 语音助手
│   │   ├── conversation_save.md          # 对话保存与载入 [新增]
│   │   └── mermaid_gen.md                # Mermaid图表生成 [新增]
│   └── agents/                           # 智能体
│       ├── void_terminal.md
│       └── code_interpreter.md
│
├── customization/                        # 自定义与扩展
│   ├── custom_buttons.md
│   ├── plugin_development.md
│   └── theme_customization.md
│
├── deployment/                           # 部署指南
│   ├── docker.md
│   ├── cloud_deploy.md
│   └── reverse_proxy.md
│
├── troubleshooting/                      # 问题排查
│   ├── faq.md
│   ├── network_issues.md
│   └── model_errors.md
│
└── reference/                            # 参考资料
    ├── config_reference.md
    └── changelog.md

# GPT Academic

[一句话介绍]

## 核心特性
- 特性卡片 x 4-6 个（带图标）

## 快速导航
- 新手用户 → 快速开始
- 我要翻译论文 → Arxiv/PDF翻译
- 我要分析代码 → 源码分析
- 我要部署服务 → 部署指南

## 界面预览
[主界面截图]

# 安装指南

## 前置条件
- Python 版本要求
- 系统要求

## 安装方式一：直接运行（推荐新手）

### 步骤1：克隆项目
[代码块]
[截图：克隆成功的终端输出]

### 步骤2：安装依赖
[代码块 - pip/conda/uv 三种方式]

### 步骤3：验证安装
[代码块]
[截图：验证成功的输出]

## 安装方式二：Docker 部署

### 步骤1：安装 Docker
[链接到官方文档]

### 步骤2：启动容器
[代码块]
[截图：容器启动成功]

## 安装方式三：一键安装脚本（Windows）
[下载链接]
[截图：脚本运行界面]

## 常见安装问题
- 问题1及解决方案
- 问题2及解决方案

# 5分钟快速上手

## 本教程将带你完成
- ✅ 配置第一个 API KEY
- ✅ 启动应用
- ✅ 进行第一次对话
- ✅ 使用第一个插件功能

## 步骤1：配置 API KEY

### 方式A：使用 OpenAI API
[截图：config.py 中 API_KEY 位置]
[代码块：配置示例]

### 方式B：使用通义千问（国内推荐）
[截图：config.py 中 DASHSCOPE_API_KEY 位置]
[代码块：配置示例]

## 步骤2：启动应用
[代码块]
[截图：启动成功，显示访问地址]

## 步骤3：访问界面
[截图：浏览器中打开的主界面，标注主要区域]
- 输入区
- 功能按钮区
- 插件下拉菜单
- 对话显示区

## 步骤4：第一次对话
[截图：输入问题]
[截图：获得回复]

## 步骤5：使用"学术润色"功能
[截图：点击学术润色按钮]
[截图：润色结果]

## 下一步
- 想翻译论文？→ [Arxiv论文翻译](../features/academic/arxiv_translation.md)
- 想分析代码？→ [源码分析](../features/programming/code_analysis.md)
- 想了解更多配置？→ [配置详解](configuration.md)

# 配置文件详解

## 配置文件说明

### 配置优先级
环境变量 > config_private.py > config.py

### 推荐做法
创建 config_private.py 存放个人配置（不会被git覆盖）

[截图：config_private.py 文件示例]

## 核心配置项

### API 配置
| 配置项 | 说明 | 示例值 |
|-------|------|-------|
| API_KEY | OpenAI API密钥 | sk-xxx |
| DASHSCOPE_API_KEY | 通义千问密钥 | sk-xxx |
| ... | ... | ... |

### 代理配置
[代码块：代理配置示例]
[截图：代理软件中查看端口]

### 模型配置
[代码块：LLM_MODEL 和 AVAIL_LLM_MODELS 配置]

### 界面配置
[截图：不同 LAYOUT 的效果对比]
[截图：不同 THEME 的效果对比]

## 配置关系图
[mermaid 图或截图：展示配置项之间的关系]

## 环境变量配置
适用于 Docker 部署场景
[代码块：docker-compose.yml 示例]

# 模型支持概览

## 支持的模型一览

### 在线模型

| 模型系列 | 具体模型 | 配置难度 | 推荐场景 |
|---------|---------|---------|---------|
| OpenAI | gpt-4o, gpt-4, gpt-3.5-turbo | ⭐⭐ | 通用场景 |
| 通义千问 | qwen-max, qwen-turbo | ⭐ | 国内用户首选 |
| 智谱GLM | glm-4, glm-3-turbo | ⭐ | 中文场景 |
| DeepSeek | deepseek-chat, deepseek-reasoner | ⭐ | 推理任务 |
| ... | ... | ... | ... |

### 本地模型

| 模型 | 显存要求 | 配置难度 |
|-----|---------|---------|
| ChatGLM3-6B | 13GB | ⭐⭐⭐ |
| ChatGLM4-9B | 24GB | ⭐⭐⭐ |
| ... | ... | ... |

## 模型选择建议

### 场景1：国内用户，快速上手
推荐：通义千问 qwen-max
[配置链接]

### 场景2：需要最强能力
推荐：GPT-4o 或 DeepSeek-R1
[配置链接]

### 场景3：离线使用/数据安全
推荐：本地部署 ChatGLM
[配置链接]

## 多模型配置
[截图：AVAIL_LLM_MODELS 配置]
[截图：界面上的模型下拉菜单]

# OpenAI / GPT 系列接入

## 前置条件
- OpenAI 账号
- 有效的 API KEY

## 步骤1：获取 API KEY

1. 访问 [OpenAI Platform](https://platform.openai.com/)
2. 登录账号
3. 进入 API Keys 页面
   [截图：API Keys 页面位置]
4. 创建新的 API KEY
   [截图：创建 API KEY]
5. 复制保存 KEY（只显示一次！）
   [截图：复制 KEY]

## 步骤2：配置 API KEY

在 `config_private.py` 中添加：

```python
API_KEY = "sk-xxxxxxxxxxxxxxxxxxxxxxxx"

API_KEY = "sk-key1,sk-key2,sk-key3"

USE_PROXY = True
proxies = {
    "http":  "http://127.0.0.1:7890",
    "https": "http://127.0.0.1:7890",
}

API_URL_REDIRECT = {
    "https://api.openai.com/v1/chat/completions": "https://your-proxy.com/v1/chat/completions"
}

API_ORG = "org-xxxxxxxx"

**需要的图片**:

| 图片文件名 | 描述 | 尺寸建议 |
|-----------|------|---------|
| `model_03_openai_apikeys_page.png` | OpenAI API Keys 页面 | 1000px |
| `model_04_openai_create_key.png` | 创建 API KEY 按钮 | 600px |
| `model_05_openai_copy_key.png` | 复制 API KEY | 600px |
| `model_06_proxy_config.png` | 代理配置代码位置 | 800px |
| `model_07_openai_verify.png` | 验证配置成功的对话 | 1000px |

---

### 3.7 模型接入 - 国产模型 (models/chinese_models.md)

**目标**: 国内用户能快速接入国产大模型

**内容结构**:

```markdown
# 国产模型接入

## 通义千问（推荐）

### 获取 API KEY
1. 访问 [阿里云百炼平台](https://dashscope.console.aliyun.com/)
   [截图：百炼平台首页]
2. 创建 API KEY
   [截图：创建 KEY 的位置]

### 配置

```python
DASHSCOPE_API_KEY = "sk-xxxxxxxx"
LLM_MODEL = "qwen-max"

ZHIPUAI_API_KEY = "xxxxxxxx"
LLM_MODEL = "glm-4"

DEEPSEEK_API_KEY = "sk-xxxxxxxx"
LLM_MODEL = "deepseek-chat"  # 或 deepseek-reasoner

BAIDU_CLOUD_API_KEY = 'xxxxx'
BAIDU_CLOUD_SECRET_KEY = 'xxxxx'
BAIDU_CLOUD_QIANFAN_MODEL = 'ERNIE-Bot-4'
LLM_MODEL = "qianfan"

XFYUN_APPID = "xxxxxxxx"
XFYUN_API_SECRET = "xxxxxxxx"
XFYUN_API_KEY = "xxxxxxxx"
LLM_MODEL = "sparkv4"

**需要的图片**:

| 图片文件名 | 描述 | 尺寸建议 |
|-----------|------|---------|
| `model_08_dashscope_home.png` | 阿里云百炼平台首页 | 1000px |
| `model_09_dashscope_apikey.png` | 百炼平台创建 API KEY | 800px |
| `model_10_zhipu_apikey.png` | 智谱开放平台 API KEY 页面 | 800px |
| `model_11_deepseek_apikey.png` | DeepSeek API KEY 页面 | 800px |
| `model_12_qianfan_console.png` | 百度千帆控制台 | 800px |
| `model_13_xfyun_console.png` | 讯飞开放平台控制台 | 800px |

---

### 3.8 功能指南 - Arxiv论文翻译 (features/academic/arxiv_translation.md)

**目标**: 用户能成功翻译一篇 Arxiv 论文

**内容结构**:

```markdown
# Arxiv 论文翻译

## 功能说明
一键将 Arxiv 论文精细翻译为中文，保留原有排版格式。

## 前置条件
- 已配置可用的大模型 API
- （可选）安装 LaTeX 环境以生成 PDF

## 使用方法

### 步骤1：获取论文 ID
从 Arxiv 论文 URL 中提取 ID

示例：`https://arxiv.org/abs/2301.00234` → ID 为 `2301.00234`

[截图：Arxiv 页面，标注 ID 位置]

### 步骤2：输入论文 ID
在输入框中输入论文 ID

[截图：输入框中输入 ID]

### 步骤3：选择翻译插件
从下拉菜单中选择 "Arxiv论文翻译" 或 "📚Arxiv论文精细翻译"

[截图：下拉菜单选择插件]

### 步骤4：点击执行
[截图：点击提交按钮]

### 步骤5：等待翻译完成
翻译过程会显示进度

[截图：翻译进度显示]

### 步骤6：获取结果
翻译完成后，可下载翻译后的 PDF

[截图：下载结果]

## 高级用法

### 自定义翻译指令
在高级参数区输入特定翻译要求

[截图：高级参数输入区]

## 常见问题

### Q: 翻译速度很慢
A: 论文越长翻译时间越长，可尝试使用更快的模型如 gpt-3.5-turbo

### Q: 部分公式显示异常
A: 确保安装了完整的 LaTeX 环境

# PDF 论文翻译

## 功能说明
上传 PDF 论文文件，翻译为中文。

## 使用方法

### 步骤1：上传 PDF 文件
点击上传区域，选择 PDF 文件

[截图：上传区域]
[截图：选择文件]

### 步骤2：选择翻译插件
从下拉菜单选择 "PDF论文翻译"

[截图：选择插件]

### 步骤3：执行翻译
[截图：翻译过程]

### 步骤4：下载结果
[截图：下载翻译结果]

## 翻译方式对比

| 方式 | 优点 | 缺点 | 适用场景 |
|-----|------|------|---------|
| 默认（GROBID） | 速度快 | 复杂排版可能丢失 | 常规论文 |
| Doc2x | 排版保留好 | 需要额外 API | 复杂排版论文 |
| Nougat | 公式识别好 | 速度较慢 | 数学公式多的论文 |

## Doc2x 配置
[配置说明]

## 常见问题
[FAQ]

# 虚空终端

## 功能说明
使用自然语言描述你的需求，自动调用合适的插件完成任务。

## 使用示例

### 示例1：翻译论文
输入：`请帮我翻译这篇论文 https://arxiv.org/abs/2301.00234`

[截图：输入自然语言指令]
[截图：自动识别并调用翻译插件]

### 示例2：分析代码
输入：`分析一下 /path/to/project 这个Python项目`

[截图：输入和结果]

### 示例3：联网搜索
输入：`搜索一下最新的 GPT-5 消息`

[截图：输入和结果]

## 支持的任务类型
- 论文翻译
- 代码分析
- 联网搜索
- 图片生成
- ...

## 使用技巧
1. 描述尽量具体
2. 可以指定使用的模型
3. 可以提供文件路径或URL

# 自定义快捷按钮

## 方法一：通过界面添加（推荐）

### 步骤1：打开自定义菜单
点击 "界面外观" → "自定义菜单"

[截图：菜单位置]

### 步骤2：添加新按钮
[截图：添加按钮的界面]

### 步骤3：配置按钮参数
- 按钮名称
- 前缀提示词（Prefix）
- 后缀提示词（Suffix）

[截图：配置参数]

### 步骤4：保存并使用
[截图：新按钮出现在界面上]

---

## 方法二：通过代码添加

编辑 `core_functional.py` 文件：

```python
"我的翻译按钮": {
    "Prefix": "请将以下内容翻译成专业的学术中文：\n\n",
    "Suffix": "",
    "Color": "secondary",
    "Visible": True,
},

**需要的图片**:

| 图片文件名 | 描述 | 尺寸建议 |
|-----------|------|---------|
| `custom_01_menu_location.png` | 自定义菜单位置 | 600px |
| `custom_02_add_button.png` | 添加按钮界面 | 800px |
| `custom_03_config_params.png` | 配置参数界面 | 800px |
| `custom_04_new_button.png` | 新按钮在界面上的位置 | 600px |

---

### 3.12 问题排查 - 常见问题 (troubleshooting/faq.md)

**目标**: 用户能快速找到常见问题的解决方案

**内容结构**:

```markdown
# 常见问题 FAQ

## 安装问题

### Q: pip install 报错 "externally-managed-environment"
**解决方案**：
使用虚拟环境或添加 `--break-system-packages` 参数
[代码示例]

### Q: 提示缺少某个依赖
**解决方案**：
[解决步骤]

---

## 配置问题

### Q: API KEY 配置后仍然报错
**排查步骤**：
1. 检查 KEY 是否正确复制
2. 检查是否有多余空格或换行
3. 检查配置文件优先级
[截图：正确的配置格式]

### Q: 代理配置不生效
**排查步骤**：
[排查步骤和截图]

---

## 使用问题

### Q: 翻译论文时卡住不动
**可能原因及解决方案**：
[解决方案]

### Q: 界面显示异常
**解决方案**：
清除浏览器缓存，使用 Chrome/Edge 浏览器

---

## 报错信息对照表

| 报错信息 | 原因 | 解决方案 |
|---------|------|---------|
| "Rate limit exceeded" | API 调用频率超限 | 等待或使用多 KEY |
| "Invalid API key" | API KEY 无效 | 检查 KEY 配置 |
| ... | ... | ... |

┌─────────────────────────────────────────────────────────────────────────┐
│                         文档撰写阶段规划                                  │
├─────────┬───────────────────────────────────────────────────────────────┤
│ 阶段 1  │ 安装指南 → 快速上手 → 国产模型接入                              │
│         │ 【目标：用户能跑起来】                                          │
├─────────┼───────────────────────────────────────────────────────────────┤
│ 阶段 2  │ Arxiv论文翻译 → PDF论文翻译 → 配置详解                          │
│         │ 【目标：用户能用核心功能】                                       │
├─────────┼───────────────────────────────────────────────────────────────┤
│ 阶段 3  │ 首页 → 基础功能 → 常见问题FAQ                                   │
│         │ 【目标：完善入口和帮助】                                         │
├─────────┼───────────────────────────────────────────────────────────────┤
│ 阶段 4  │ OpenAI接入 → 虚空终端 → 源码分析                                │
│         │ 【目标：覆盖常用场景】                                           │
├─────────┼───────────────────────────────────────────────────────────────┤
│ 阶段 5  │ 自定义按钮 → Docker部署 → 联网搜索                              │
│         │ 【目标：扩展和部署】                                             │
├─────────┼───────────────────────────────────────────────────────────────┤
│ 阶段 6  │ Latex处理 → 模型概览 → 多模型询问                               │
│         │ 【目标：学术进阶功能】                                           │
├─────────┼───────────────────────────────────────────────────────────────┤
│ 阶段 7  │ 本地模型 → 插件开发 → Azure接入                                 │
│         │ 【目标：高级用户需求】                                           │
├─────────┼───────────────────────────────────────────────────────────────┤
│ 阶段 8  │ 代码注释 → 图片生成 → 论文阅读助手                              │
│         │ 【目标：补充功能文档】                                           │
├─────────┼───────────────────────────────────────────────────────────────┤
│ 阶段 9  │ 云服务部署 → 网络问题排查 → 主题定制                            │
│         │ 【目标：部署和定制】                                             │
├─────────┼───────────────────────────────────────────────────────────────┤
│ 阶段 10 │ Markdown翻译 → 语音助手 → 代码解释器                            │
│         │ 【目标：特色功能】                                               │
├─────────┼───────────────────────────────────────────────────────────────┤
│ 阶段 11 │ 配置参考 → 反向代理 → 自定义模型                                │
│         │ 【目标：参考文档】                                               │
├─────────┼───────────────────────────────────────────────────────────────┤
│ 阶段 12 │ 模型错误排查 → 更新日志                                         │
│         │ 【目标：收尾】                                                   │
├─────────┼───────────────────────────────────────────────────────────────┤
│ 阶段 13 │ PDF总结 → Word总结 → PDF问答(ChatPDF)                           │
│         │ 【目标：学术文档总结】                                           │
├─────────┼───────────────────────────────────────────────────────────────┤
│ 阶段 14 │ Tex摘要生成 → 谷歌学术助手 → Arxiv下载与摘要翻译                 │
│         │ 【目标：学术辅助功能】                                           │
├─────────┼───────────────────────────────────────────────────────────────┤
│ 阶段 15 │ Latex纠错高亮 → PDF翻译(NOUGAT) → 批量文件询问                   │
│         │ 【目标：学术高级功能】                                           │
├─────────┼───────────────────────────────────────────────────────────────┤
│ 阶段 16 │ Jupyter分析 → 自定义源码分析 → 批量函数注释                      │
│         │ 【目标：编程功能补充】                                           │
├─────────┼───────────────────────────────────────────────────────────────┤
│ 阶段 17 │ 对话保存载入 → Mermaid图表生成                                   │
│         │ 【目标：对话功能补充】                                           │
└─────────┴───────────────────────────────────────────────────────────────┘

1. 阅读规划 → 了解本阶段3篇文档的目标
      ↓
2. 准备素材 → 截图、录制GIF、收集代码示例
      ↓
3. 撰写文档 → 按模板填充内容
      ↓
4. 本地预览 → mkdocs serve 检查效果
      ↓
5. 自检清单 → 对照检查清单逐项确认
      ↓
6. 更新进度 → 标记完成状态和日期

site_name: GPT Academic
site_url: https://github.com/binary-husky/gpt_academic
site_description: "GPT Academic - 为GPT/LLM提供实用化交互界面，特别优化论文阅读/润色/写作体验"
site_author: "GPT Academic Team"
repo_url: https://github.com/binary-husky/gpt_academic
repo_name: binary-husky/gpt_academic
copyright: "Copyright © 2025 GPT Academic Team"

theme:
  name: shadcn
  show_stargazers: true
  git_enabled: false
  nav_sort: false
  features:
    - content.code.copy
    - content.code.annotate

nav:
  - 首页: index.md

  - 快速开始:
      - 安装指南: get_started/installation.md
      - 快速上手: get_started/quickstart.md
      - 配置详解: get_started/configuration.md

  - 模型接入:
      - 模型概览: models/overview.md
      - OpenAI / GPT: models/openai.md
      - Azure OpenAI: models/azure.md
      - 国产模型: models/chinese_models.md
      - 本地模型: models/local_models.md
      - 自定义模型: models/custom_models.md

  - 功能指南:
      - 基础功能: features/basic_functions.md
      - 学术功能:
          - Arxiv论文翻译: features/academic/arxiv_translation.md
          - PDF论文翻译: features/academic/pdf_translation.md
          - Latex项目处理: features/academic/latex_polish.md
          - 论文阅读助手: features/academic/paper_reading.md
          - 批量总结PDF: features/academic/pdf_summary.md
          - 批量总结Word: features/academic/word_summary.md
          - PDF问答(ChatPDF): features/academic/pdf_qa.md
          - Tex论文摘要生成: features/academic/tex_abstract.md
          - 谷歌学术助手: features/academic/google_scholar.md
          - Arxiv下载与摘要翻译: features/academic/arxiv_download.md
          - Latex纠错+高亮对比: features/academic/latex_proofread.md
          - PDF精准翻译(NOUGAT): features/academic/pdf_nougat.md
          - 批量文件询问: features/academic/batch_file_query.md
      - 编程功能:
          - 源码分析: features/programming/code_analysis.md
          - 代码注释生成: features/programming/code_comment.md
          - Markdown翻译: features/programming/markdown_translate.md
          - Jupyter Notebook分析: features/programming/jupyter_analysis.md
          - 自定义源码分析: features/programming/custom_code_analysis.md
          - 批量函数注释生成: features/programming/batch_comment_gen.md
      - 对话功能:
          - 联网搜索: features/conversation/internet_search.md
          - 多模型询问: features/conversation/multi_model_query.md
          - 图片生成: features/conversation/image_generation.md
          - 语音助手: features/conversation/voice_assistant.md
          - 对话保存与载入: features/conversation/conversation_save.md
          - Mermaid图表生成: features/conversation/mermaid_gen.md
      - 智能体:
          - 虚空终端: features/agents/void_terminal.md
          - 代码解释器: features/agents/code_interpreter.md

  - 自定义扩展:
      - 自定义按钮: customization/custom_buttons.md
      - 插件开发: customization/plugin_development.md
      - 主题定制: customization/theme_customization.md

  - 部署指南:
      - Docker部署: deployment/docker.md
      - 云服务部署: deployment/cloud_deploy.md
      - 反向代理: deployment/reverse_proxy.md

  - 问题排查:
      - 常见问题: troubleshooting/faq.md
      - 网络问题: troubleshooting/network_issues.md
      - 模型错误: troubleshooting/model_errors.md

  - 参考:
      - 配置参考: reference/config_reference.md
      - 更新日志: reference/changelog.md

plugins:
  - search:
      lang:
        - en
        - zh
      separator: '[\s\-\.\(\)\/]+'
      min_search_length: 2
      prebuild_index: true
      indexing: 'full'
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            members_order: source
            show_submodules: true

markdown_extensions:
  - admonition
  - footnotes
  - tables
  - extra
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.progressbar
  - pymdownx.snippets
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - shadcn.extensions.iconify

extra_css:
  - https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@400;500;600;700&display=swap
  - stylesheets/feature-cards.css
  - stylesheets/tabbed-code.css
  - stylesheets/readability-enhancements.css
  - stylesheets/code-enhancements.css
  - stylesheets/syntax-highlight.css
  - stylesheets/table-enhancements.css
  - stylesheets/jupyter-simple.css
  - stylesheets/nav-scroll-fix.css
  - stylesheets/workflow.css
  - stylesheets/animations.css
  - stylesheets/mermaid.css
  - stylesheets/mkdocstrings.css
  - stylesheets/responsive.css

extra_javascript:
  - javascripts/tabbed-code.js
  - javascripts/code-copy.js
  - javascripts/search-fix.js
  - javascripts/code-zoom.js
  - javascripts/nav-scroll-fix.js
  - javascripts/animations.js
  - javascripts/responsive.js

# {功能名称}

## 功能说明
{一句话描述这个功能能做什么}

## 前置条件
- {条件1}
- {条件2}

## 使用方法

### 步骤1：{步骤名称}
{步骤说明}

<!-- IMAGE: {图片文件名} -->
<!-- 描述: {图片应展示的内容} -->
<!-- 尺寸建议: {宽度}px -->
![{alt文本}](../images/{图片文件名})

### 步骤2：{步骤名称}
{步骤说明}

<!-- IMAGE: {图片文件名} -->
![{alt文本}](../images/{图片文件名})

## 高级用法
{可选的高级配置或用法}

## 常见问题

### Q: {问题1}
**A**: {答案1}

### Q: {问题2}
**A**: {答案2}

## 相关文档
- [{相关文档1}]({链接})
- [{相关文档2}]({链接})