Refactor documentation for improved clarity and consistency

- Updated tables for service ports, environment variables, HTTP status codes, and error codes to enhance readability.
- Streamlined JavaScript examples for file conversion and added comments for better understanding.
- Enhanced troubleshooting section with clearer formatting and additional explanations.
- Improved licensing section with detailed requirements and third-party component licenses.
- Organized the document structure for better navigation and accessibility.
This commit is contained in:
Your Name 2026-01-25 16:10:07 +08:00
parent caecb2e001
commit 394dcbec1a
11 changed files with 538 additions and 497 deletions

View file

@ -16,11 +16,11 @@ ConvertX-CN 專案採用 **GNU Affero General Public License v3.0 (AGPL-3.0)**
## 授權摘要
| 項目 | 說明 |
|------|------|
| **授權類型** | AGPL-3.0 |
| 項目 | 說明 |
| ------------ | --------------------- |
| **授權類型** | AGPL-3.0 |
| **授權檔案** | [LICENSE](../LICENSE) |
| **適用範圍** | 整個專案所有程式碼 |
| **適用範圍** | 整個專案所有程式碼 |
---
@ -53,6 +53,7 @@ ConvertX-CN 專案採用 **GNU Affero General Public License v3.0 (AGPL-3.0)**
### 📋 保留授權聲明
分發時必須包含:
- 原始授權聲明
- 著作權聲明
- 完整的 AGPL-3.0 授權文字
@ -60,6 +61,7 @@ ConvertX-CN 專案採用 **GNU Affero General Public License v3.0 (AGPL-3.0)**
### 📋 公開原始碼
如果您修改了程式碼:
- 必須公開修改後的原始碼
- 必須使用相同的 AGPL-3.0 授權
@ -68,12 +70,14 @@ ConvertX-CN 專案採用 **GNU Affero General Public License v3.0 (AGPL-3.0)**
**這是 AGPL 與 GPL 的主要差異:**
如果您將修改後的版本部署為網路服務(如 SaaS您必須
- 向服務使用者提供取得原始碼的方式
- 原始碼必須包含您的所有修改
### 📋 標明變更
如果您修改了程式碼:
- 必須標明您做了哪些修改
- 必須標明修改日期
@ -88,6 +92,7 @@ ConvertX-CN 專案採用 **GNU Affero General Public License v3.0 (AGPL-3.0)**
### Q: 我修改了程式碼後部署在公司內部,需要公開嗎?
**A: 視情況而定**
- 如果只有公司內部員工使用 → 不需要公開
- 如果對外提供服務(客戶可存取)→ 需要公開
@ -102,6 +107,7 @@ ConvertX-CN 專案採用 **GNU Affero General Public License v3.0 (AGPL-3.0)**
### Q: 如果我將 ConvertX-CN 作為 SaaS 服務提供,需要做什麼?
**A: 您需要**
1. 在服務中提供原始碼下載連結
2. 包含您對程式碼的所有修改
3. 使用 AGPL-3.0 授權
@ -114,29 +120,29 @@ ConvertX-CN 使用了多個第三方開源元件,各元件的授權如下:
### 上游專案
| 專案 | 授權 |
|------|------|
| 專案 | 授權 |
| ----------------------------------------------- | -------- |
| [ConvertX](https://github.com/C4illin/ConvertX) | AGPL-3.0 |
### 轉換引擎
| 元件 | 授權 |
|------|------|
| FFmpeg | LGPL / GPL |
| ImageMagick | Apache 2.0 |
| LibreOffice | MPL 2.0 |
| Pandoc | GPL 2.0 |
| Calibre | GPL 3.0 |
| 元件 | 授權 |
| ------------- | ---------- |
| FFmpeg | LGPL / GPL |
| ImageMagick | Apache 2.0 |
| LibreOffice | MPL 2.0 |
| Pandoc | GPL 2.0 |
| Calibre | GPL 3.0 |
| Tesseract OCR | Apache 2.0 |
### 框架與函式庫
| 元件 | 授權 |
|------|------|
| Bun | MIT |
| Elysia | MIT |
| React | MIT |
| TailwindCSS | MIT |
| 元件 | 授權 |
| ----------- | ---- |
| Bun | MIT |
| Elysia | MIT |
| React | MIT |
| TailwindCSS | MIT |
---
@ -145,6 +151,7 @@ ConvertX-CN 使用了多個第三方開源元件,各元件的授權如下:
完整的 AGPL-3.0 授權文字請參閱專案根目錄的 [LICENSE](../LICENSE) 檔案。
您也可以在以下網址查看:
- [GNU AGPL-3.0 官方網站](https://www.gnu.org/licenses/agpl-3.0.html)
- [AGPL-3.0 中文翻譯](https://www.gnu.org/licenses/agpl-3.0.zh-cn.html)