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:
parent
caecb2e001
commit
394dcbec1a
11 changed files with 538 additions and 497 deletions
|
|
@ -17,12 +17,12 @@
|
|||
|
||||
## 前置需求
|
||||
|
||||
| 需求 | 最低規格 | 建議規格 |
|
||||
|------|---------|---------|
|
||||
| Docker | 20.10+ | 24.0+ |
|
||||
| 記憶體 | 4 GB | 8 GB |
|
||||
| 磁碟空間 | 10 GB | 30 GB |
|
||||
| 作業系統 | Linux / macOS / Windows | Linux |
|
||||
| 需求 | 最低規格 | 建議規格 |
|
||||
| -------- | ----------------------- | -------- |
|
||||
| Docker | 20.10+ | 24.0+ |
|
||||
| 記憶體 | 4 GB | 8 GB |
|
||||
| 磁碟空間 | 10 GB | 30 GB |
|
||||
| 作業系統 | Linux / macOS / Windows | Linux |
|
||||
|
||||
> 💡 **提示**:Windows 使用者請確保已安裝 [Docker Desktop](https://docs.docker.com/desktop/install/windows-install/)
|
||||
|
||||
|
|
@ -157,11 +157,13 @@ docker logs convertx-cn
|
|||
4. 下載轉換後的 PDF 檔案
|
||||
|
||||
**輸入:**
|
||||
|
||||
```
|
||||
report.docx (Microsoft Word 文件)
|
||||
```
|
||||
|
||||
**輸出:**
|
||||
|
||||
```
|
||||
report.pdf (PDF 文件)
|
||||
```
|
||||
|
|
@ -173,11 +175,13 @@ report.pdf (PDF 文件)
|
|||
3. 點擊「轉換」
|
||||
|
||||
**輸入:**
|
||||
|
||||
```
|
||||
video.mov (QuickTime 影片, 500 MB)
|
||||
```
|
||||
|
||||
**輸出:**
|
||||
|
||||
```
|
||||
video.mp4 (MP4 影片, 壓縮後約 200 MB)
|
||||
```
|
||||
|
|
@ -190,11 +194,13 @@ video.mp4 (MP4 影片, 壓縮後約 200 MB)
|
|||
4. 點擊「翻譯」
|
||||
|
||||
**輸入:**
|
||||
|
||||
```
|
||||
paper.pdf (英文學術論文,含數學公式)
|
||||
```
|
||||
|
||||
**輸出:**
|
||||
|
||||
```
|
||||
paper_translated.pdf (中文翻譯,公式與排版保留)
|
||||
```
|
||||
|
|
@ -203,13 +209,13 @@ paper_translated.pdf (中文翻譯,公式與排版保留)
|
|||
|
||||
## 常見問題快查
|
||||
|
||||
| 問題 | 解決方法 |
|
||||
|------|---------|
|
||||
| 問題 | 解決方法 |
|
||||
| ------------------ | ---------------------------------------------- |
|
||||
| 登入後被踢回登入頁 | 加上 `HTTP_ALLOWED=true` 或 `TRUST_PROXY=true` |
|
||||
| 重啟後資料消失 | 確認 `./data:/app/data` 且資料夾存在 |
|
||||
| 重啟後被登出 | 設定固定的 `JWT_SECRET` |
|
||||
| 中文顯示亂碼 | 使用一般版或 Full 版(含完整字型) |
|
||||
| 轉換時間過長 | 增加容器記憶體限制或升級硬體 |
|
||||
| 重啟後資料消失 | 確認 `./data:/app/data` 且資料夾存在 |
|
||||
| 重啟後被登出 | 設定固定的 `JWT_SECRET` |
|
||||
| 中文顯示亂碼 | 使用一般版或 Full 版(含完整字型) |
|
||||
| 轉換時間過長 | 增加容器記憶體限制或升級硬體 |
|
||||
|
||||
> 📖 更多問題請參閱 [06-錯誤排查與支援](06-錯誤排查與支援.md)
|
||||
|
||||
|
|
@ -217,12 +223,12 @@ paper_translated.pdf (中文翻譯,公式與排版保留)
|
|||
|
||||
## 下一步
|
||||
|
||||
| 需求 | 推薦閱讀 |
|
||||
|------|---------|
|
||||
| 詳細部署設定 | [02-部署指南](02-部署指南.md) |
|
||||
| 需求 | 推薦閱讀 |
|
||||
| ------------ | ----------------------------------------- |
|
||||
| 詳細部署設定 | [02-部署指南](02-部署指南.md) |
|
||||
| 環境變數設定 | [03-環境變數與設定](03-環境變數與設定.md) |
|
||||
| 了解所有功能 | [04-功能總覽](04-功能總覽.md) |
|
||||
| API 整合 | [05-API文件](05-API文件.md) |
|
||||
| 了解所有功能 | [04-功能總覽](04-功能總覽.md) |
|
||||
| API 整合 | [05-API文件](05-API文件.md) |
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue