README

中文 | English








 红墨官方站点上线啦，注册即送50体验积分！

 注册需要邀请码！可以到 https://watcha.cn/square/discusspost_id=1380 获取



  


 点击访问在线体验站 → Redink.top






使用红墨生成的各类小红书封面 - AI驱动，风格统一，文字准确



---

 ✨ 效果展示

 输入一句话，生成完整图文


Step 1: 智能大纲生成



!大纲示例

功能特性：
- ✏️ 可编辑每页内容
- 🔄 可调整页面顺序（不建议）
- ✨ 自定义每页描述（强烈推荐）




🎨 Step 2: 封面页生成



!封面示例

封面亮点：
- 🎯 符合个人风格
- 📝 文字准确无误
- 🌈 视觉统一协调




📚 Step 3: 内容页批量生成



!内容页示例

生成说明：
- ⚡ 并发生成所有页面（默认最多 15 张）
- ⚠️ 如 API 不支持高并发，请在设置中关闭
- 🔧 支持单独重新生成不满意的页面



---

 🏗️ 技术架构





 🔧 后端技术栈

| 技术 | 说明 |
|------|------|
| 语言 | Python 3.11+ |
| 框架 | Flask |
| 包管理 | uv |
| 文案AI | Gemini 3 |
| 图片AI | 🍌 Nano banana Pro |




 🎨 前端技术栈

| 技术 | 说明 |
|------|------|
| 框架 | Vue 3 + TypeScript |
| 构建工具 | Vite |
| 状态管理 | Pinia |
| 样式 | Modern CSS |





---

 📦 如何自己部署

 方式一：Docker 部署（推荐）

最简单的部署方式，一行命令即可启动：

bash
docker run -d -p 12398:12398 -v ./history:/app/history -v ./output:/app/output histonemax/redink:latest


访问 http://localhost:12398，在 Web 界面的设置页面配置你的 API Key 即可使用。

使用 docker-compose（可选）：

下载 docker-compose.yml 后：

bash
docker-compose up -d


Docker 部署说明：
- 容器内不包含任何 API Key，需要在 Web 界面配置
- 使用 -v ./history:/app/history 持久化历史记录
- 使用 -v ./output:/app/output 持久化生成的图片
- 可选：挂载自定义配置文件 -v ./text_providers.yaml:/app/text_providers.yaml

---

 方式二：本地开发部署

前置要求：
- Python 3.11+
- Node.js 18+
- pnpm
- uv

 1. 克隆项目
bash
git clone https://github.com/HisMax/RedInk.git
cd RedInk


 2. 配置 API 服务

复制配置模板文件：
bash
cp text_providers.yaml.example text_providers.yaml
cp image_providers.yaml.example image_providers.yaml


编辑配置文件，填入你的 API Key 和服务配置。也可以启动后在 Web 界面的设置页面进行配置。

 3. 安装后端依赖
bash
uv sync


 4. 安装前端依赖
bash
cd frontend
pnpm install


 5. 启动服务

 一键启动（推荐）

双击运行启动脚本，自动安装依赖并启动前后端：

- macOS: start.sh 或双击 scripts/start-macos.command
- Linux: ./start.sh
- Windows: 双击 start.bat

启动后自动打开浏览器访问 http://localhost:5173

 手动启动

启动后端:
bash
uv run python -m backend.app

访问: http://localhost:12398

启动前端:
bash
cd frontend
pnpm dev

访问: http://localhost:5173

---

 🔧 配置说明

 配置方式

项目支持两种配置方式：

1. Web 界面配置（推荐）：启动服务后，在设置页面可视化配置
2. YAML 文件配置：直接编辑配置文件

 文本生成配置

配置文件: text_providers.yaml

yaml
 当前激活的服务商
active_provider: openai

providers:
   OpenAI 官方或兼容接口
  openai:
    type: openai_compatible
    api_key: sk-xxxxxxxxxxxxxxxxxxxx
    base_url: https://api.openai.com/v1
    model: gpt-4o

   Google Gemini（原生接口）
  gemini:
    type: google_gemini
    api_key: AIzaxxxxxxxxxxxxxxxxxxxxxxxxx
    model: gemini-2.0-flash


 图片生成配置

配置文件: image_providers.yaml

yaml
 当前激活的服务商
active_provider: gemini

providers:
   Google Gemini 图片生成
  gemini:
    type: google_genai
    api_key: AIzaxxxxxxxxxxxxxxxxxxxxxxxxx
    model: gemini-3-pro-image-preview
    high_concurrency: false   高并发模式

   OpenAI 兼容接口
  openai_image:
    type: image_api
    api_key: sk-xxxxxxxxxxxxxxxxxxxx
    base_url: https://your-api-endpoint.com
    model: dall-e-3
    high_concurrency: false


 高并发模式说明

- 关闭（默认）：图片逐张生成，适合 GCP 300$ 试用账号或有速率限制的 API
- 开启：图片并行生成（最多15张同时），速度更快，但需要 API 支持高并发

⚠️ GCP 300$ 试用账号不建议启用高并发，可能会触发速率限制导致生成失败。

---

 ⚠️