60 lines
1.2 KiB
Markdown
60 lines
1.2 KiB
Markdown
# AI 生成登记手册
|
|
|
|
一个基于 Flask 的 Web 应用，输入主题即可由 AI 生成结构化的登记手册。
|
|
|
|
## 功能
|
|
|
|
- 输入主题，生成完整登记手册（封面、目录、正文、附录）
|
|
- 支持在线预览与一键导出 Markdown
|
|
- 内置离线模板引擎（未配置 API Key 时使用）
|
|
- 可选接入 OpenAI 兼容接口
|
|
|
|
## 目录结构
|
|
|
|
```
|
|
ai-registration-handbook/
|
|
├── app.py
|
|
├── requirements.txt
|
|
├── README.md
|
|
├── templates/
|
|
│ └── index.html
|
|
├── static/
|
|
│ ├── style.css
|
|
│ └── app.js
|
|
└── handbook/
|
|
├── __init__.py
|
|
├── generator.py
|
|
└── templates.py
|
|
```
|
|
|
|
## 安装
|
|
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
## 运行
|
|
|
|
```bash
|
|
python app.py
|
|
```
|
|
|
|
浏览器访问 http://127.0.0.1:5000
|
|
|
|
## 配置 AI（可选）
|
|
|
|
设置环境变量后启用真实 AI 生成：
|
|
|
|
```bash
|
|
export OPENAI_API_KEY=your-key
|
|
export OPENAI_BASE_URL=https://api.openai.com/v1
|
|
export OPENAI_MODEL=gpt-4o-mini
|
|
```
|
|
|
|
未配置时使用内置模板引擎生成示例手册。
|
|
|
|
## 接口
|
|
|
|
- `POST /api/generate` 请求体 `{"topic": "..."}` 返回 `{"markdown": "..."}`
|
|
- `POST /api/export` 请求体 `{"topic": "...", "markdown": "..."}` 下载 `.md` 文件
|