# docscn

**Repository Path**: mhouse/docscn

## Basic Information

- **Project Name**: docscn
- **Description**: 中文开发文档助手 - 自动翻译技术文档，保留代码块
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-26
- **Last Updated**: 2026-03-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DocsCN 📚

> 中文开发文档助手 - 自动翻译技术文档，保留代码块，输出优雅中文文档

<p align="center">
  <img src="https://img.shields.io/npm/v/docscn?style=flat-square" alt="npm version">
  <img src="https://img.shields.io/npm/l/docscn?style=flat-square" alt="license">
  <img src="https://img.shields.io/node/v/docscn?style=flat-square" alt="node version">
</p>

<p align="center">
  <a href="#特性">特性</a> •
  <a href="#安装">安装</a> •
  <a href="#快速开始">快速开始</a> •
  <a href="#配置">配置</a> •
  <a href="#示例">示例</a>
</p>

---

## ✨ 特性

- 🚀 **智能翻译** - 支持 OpenAI、DeepL、百度等多种翻译服务
- 📝 **代码保护** - 自动识别代码块，只翻译说明文字，保留所有代码
- 💰 **智能缓存** - 本地缓存翻译结果，节省API费用
- 📁 **批量处理** - 支持单文件或整个目录批量翻译
- 🌐 **双语对照** - 可选生成双语对照文档，方便校对
- 🔧 **多格式支持** - 支持 Markdown、MDX、RST 等技术文档格式

## 📦 安装

```bash
# 全局安装
npm install -g docscn

# 或本地安装
npm install --save-dev docscn
```

## 🚀 快速开始

### 1. 设置 API 密钥

```bash
# 使用 OpenAI（推荐）
export OPENAI_API_KEY=sk-your-key

# 或使用 DeepL
export DEEPL_API_KEY=your-key

# 或使用百度翻译
export BAIDU_APP_ID=your-app-id
export BAIDU_SECRET_KEY=your-secret
```

### 2. 翻译文档

```bash
# 翻译单个文件
docscn translate README.md

# 翻译整个目录
docscn translate docs/ -o docs-cn/

# 生成双语对照
docscn translate README.md --bilingual
```

## ⚙️ 配置

### 配置文件 `.docscnrc`

在项目根目录创建 `.docscnrc` 文件：

```json
{
  "provider": "openai",
  "apiKey": "sk-your-key",
  "model": "gpt-3.5-turbo",
  "targetLang": "zh-CN",
  "useCache": true
}
```

### CLI 参数

| 参数 | 说明 | 默认值 |
|------|------|--------|
| `-o, --output <dir>` | 输出目录 | `./docs-cn` |
| `-p, --provider <name>` | 翻译服务 | `openai` |
| `-k, --key <key>` | API 密钥 | - |
| `-b, --bilingual` | 双语对照 | `false` |
| `--model <model>` | OpenAI 模型 | `gpt-3.5-turbo` |
| `--cache` | 使用缓存 | `true` |

## 📖 示例

### 翻译前

```markdown
## Installation

Install with npm:

\`\`\`bash
npm install express
\`\`\`

Or with yarn:

\`\`\`bash
yarn add express
\`\`\`
```

### 翻译后

```markdown
## 安装

使用 npm 安装：

\`\`\`bash
npm install express
\`\`\`

或使用 yarn：

\`\`\`bash
yarn add express
\`\`\`
```

> 注意：代码块被完整保留，只有说明文字被翻译

## 🔧 支持的翻译服务

| 服务商 | 优点 | 注册地址 |
|--------|------|----------|
| OpenAI | 翻译质量高，专业术语准确 | [platform.openai.com](https://platform.openai.com) |
| DeepL | 欧洲语言支持好 | [deepl.com/pro](https://www.deepl.com/pro) |
| 百度翻译 | 国内访问稳定，免费额度 | [fanyi-api.baidu.com](https://fanyi-api.baidu.com) |

## 🛠️ 开发

```bash
# 克隆仓库
git clone https://gitee.com/yourname/docscn.git
cd docscn

# 安装依赖
npm install

# 运行测试
npm test

# 运行示例
npm run example
```

## 📄 许可证

MIT © [金虾](https://gitee.com/yourname)

---

<p align="center">
  如果这个项目对你有帮助，请给个 ⭐️ Star！
</p>