convertor/docs/說明文件.md
Your Name 394dcbec1a 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.
2026-01-25 16:10:07 +08:00

3.1 KiB

ConvertX-CN 文件中心

歡迎來到 ConvertX-CN 文件!選擇您需要的章節快速找到所需資訊。


📚 文件目錄

章節 說明
00-專案總覽 專案定位、功能特色、版本比較
01-快速開始 5 分鐘部署完成
02-部署指南 Docker 設定、反向代理、HTTPS
03-環境變數與設定 所有可用設定與推薦值
04-功能總覽 轉換器、OCR、PDF 翻譯
05-API文件 REST & GraphQL API
06-錯誤排查與支援 常見問題與解決方案
07-開發與貢獻指南 專案結構、貢獻規範
08-授權說明 AGPL-3.0 授權

🚀 快速入門

剛開始使用?從這裡開始:

  1. 專案總覽 — 了解 ConvertX-CN 是什麼
  2. 快速開始 — 5 分鐘內完成部署
  3. 錯誤排查 — 解決常見問題

📁 補充文件

以下為詳細的補充文件,提供更深入的資訊:

部署相關

文件 說明
部署指南/Docker.md Docker 部署詳細說明
部署指南/反向代理.md Nginx / Traefik / Caddy
範例配置/說明文件.md 可直接使用的配置檔

功能說明

文件 說明
功能說明/轉換器.md 所有轉換器詳細資訊
功能說明/OCR.md OCR 功能說明
功能說明/翻譯功能.md PDF 翻譯功能

開發相關

文件 說明
開發指南/專案結構.md 程式碼結構說明
開發指南/貢獻指南.md 如何參與專案
API/總覽.md API 詳細說明

📄 授權

本專案採用 AGPL-3.0 授權,詳情請參閱 08-授權說明


🔗 快速連結