convertor/docs/說明文件.md

75 lines
2.5 KiB
Markdown

# ConvertX-CN 文件中心
歡迎來到 ConvertX-CN 文件!選擇您需要的章節快速找到所需資訊。
---
## 📚 文件目錄
| 章節 | 說明 |
|------|------|
| [00-專案總覽](00-專案總覽.md) | 專案定位、功能特色、版本比較 |
| [01-快速開始](01-快速開始.md) | 5 分鐘部署完成 |
| [02-部署指南](02-部署指南.md) | Docker 設定、反向代理、HTTPS |
| [03-環境變數與設定](03-環境變數與設定.md) | 所有可用設定與推薦值 |
| [04-功能總覽](04-功能總覽.md) | 轉換器、OCR、PDF 翻譯 |
| [05-API文件](05-API文件.md) | REST & GraphQL API |
| [06-錯誤排查與支援](06-錯誤排查與支援.md) | 常見問題與解決方案 |
| [07-開發與貢獻指南](07-開發與貢獻指南.md) | 專案結構、貢獻規範 |
| [08-授權說明](08-授權說明.md) | AGPL-3.0 授權 |
---
## 🚀 快速入門
剛開始使用?從這裡開始:
1. **[專案總覽](00-專案總覽.md)** — 了解 ConvertX-CN 是什麼
2. **[快速開始](01-快速開始.md)** — 5 分鐘內完成部署
3. **[錯誤排查](06-錯誤排查與支援.md)** — 解決常見問題
---
## 📁 補充文件
以下為詳細的補充文件,提供更深入的資訊:
### 部署相關
| 文件 | 說明 |
|------|------|
| [部署指南/Docker.md](部署指南/Docker.md) | Docker 部署詳細說明 |
| [部署指南/反向代理.md](部署指南/反向代理.md) | Nginx / Traefik / Caddy |
| [範例配置/說明文件.md](範例配置/說明文件.md) | 可直接使用的配置檔 |
### 功能說明
| 文件 | 說明 |
|------|------|
| [功能說明/轉換器.md](功能說明/轉換器.md) | 所有轉換器詳細資訊 |
| [功能說明/OCR.md](功能說明/OCR.md) | OCR 功能說明 |
| [功能說明/翻譯功能.md](功能說明/翻譯功能.md) | PDF 翻譯功能 |
### 開發相關
| 文件 | 說明 |
|------|------|
| [開發指南/專案結構.md](開發指南/專案結構.md) | 程式碼結構說明 |
| [開發指南/貢獻指南.md](開發指南/貢獻指南.md) | 如何參與專案 |
| [API/總覽.md](API/總覽.md) | API 詳細說明 |
---
## 📄 授權
本專案採用 **AGPL-3.0** 授權,詳情請參閱 [08-授權說明](08-授權說明.md)。
---
## 🔗 快速連結
- 📦 [GitHub Repo](https://github.com/pi-docket/ConvertX-CN)
- 🐛 [Issues](https://github.com/pi-docket/ConvertX-CN/issues)
- 💬 [Discussions](https://github.com/pi-docket/ConvertX-CN/discussions)
- 📝 [Changelog](../CHANGELOG.md)
- 📄 [License](../LICENSE)