為專案貢獻

感謝您對本專案的關注！在開始貢獻之前，請花些時間閱讀以下指南，以確保您的貢獻能夠順利被接受。

不接受的貢獻類型

1. 文檔國際化/翻譯
2. 與核心基礎設施相關的貢獻，例如 HTTP API 等
3. 明確標記為「No help needed」的議題（包括 Byaidu/PDFMathTranslate 和 PDFMathTranslate-next/PDFMathTranslate-next 存儲庫中的議題）
4. 維護者認為不適當的其他貢獻
5. 貢獻文檔，但修改非英文的其他語言文檔
6. 需要修改 PDF 文件的 PR
7. 修改 pdf2zh_next/gui_translation.yaml 文件的 PR

請勿提交與上述類型相關的 PR。

• Add new features
• Add new dependencies
• Modify project architecture

PRs that are recommended to submit directly

• Fix bugs
• Fix typos
• Improve documentation
• Refactor code
• Improve test cases

OUTPUT

建議在提交前透過 Issue 與維護者討論的 PR

• 新增功能
• 新增依賴項
• 修改專案架構

建議直接提交的 PR

• 修復錯誤
• 修正錯字
• 改進文檔
• 重構程式碼

• 改進測試案例

• Add new features

• Add new dependencies
• Modify project architecture

For the following types of PRs, it is recommended to submit directly: - [ ] Fix bugs - [ ] Fix typos - [ ] Improve documentation - [ ] Refactor code - [ ] Improve test cases

1. PRs related to UI modifications. (The current UI is considered stable, and we do not plan to make significant changes to it).
2. PRs related to the addition of new LLM services. (We currently support OpenAI, Azure OpenAI, Aliyun, and SiliconFlow, which are sufficient for our needs).
3. PRs related to the addition of new translation services. (We currently support Google Translate, DeepL, and Youdao, which are sufficient for our needs).

OUTPUT

1. 與多用戶共享功能相關的 PR。（本專案主要設計為單用戶使用，無意引入完整的多用戶系統）。
2. 與 UI 修改相關的 PR。（當前 UI 被認為是穩定的，我們不計劃對其進行重大更改）。
3. 與新增 LLM 服務相關的 PR。（我們目前支持 OpenAI、Azure OpenAI、Aliyun 和 SiliconFlow，這些已滿足我們的需求）。
4. 與新增翻譯服務相關的 PR。（我們目前支持 Google Translate、DeepL 和 Youdao，這些已滿足我們的需求）。

貢獻流程

1. 複製此儲存庫並在本地克隆。
2. 創建一個新分支：git checkout -b feature/<feature-name>。
3. 開發並確保你的代碼符合要求。
4. 提交你的代碼：

   git add .
   git commit -m "<semantic commit message>"
   

5. 推送至你的儲存庫：git push origin feature/<feature-name>。
6. 在 GitHub 上創建一個 PR，提供詳細描述，並請求 @awwaawwa 進行審查。
7. 確保所有自動化檢查通過。

基本要求

1. 工作流程

• 請從 main 分支進行 fork，並在您 fork 的分支上進行開發。
• 提交 Pull Request (PR) 時，請提供詳細的變更說明。
• 如果您的 PR 未通過自動化檢查（顯示為 checks failed 和紅色叉號），請查看對應的 details 並修改您的提交，以確保新的 PR 通過所有檢查。

2. 開發與測試

• 使用命令 pip install -e . 進行開發和測試。

3. 代碼格式化

• 配置 pre-commit 工具並啟用 black 和 flake8 進行代碼格式化。

4. 依賴項更新

• 如果您引入了新的依賴項，請及時更新 pyproject.toml 文件中的依賴列表。

5. 文件更新

• 如果您新增了命令行選項，請相應地更新所有語言版本的 README.md 文件中的命令行選項列表。

6. 提交訊息

• 使用 Conventional Commits，例如：feat(translator): add openai。

7. 程式碼風格

• 確保您提交的代碼符合基本的編碼風格標準。
• 變量命名請使用 snake_case 或 camelCase。

8. 文件格式

• 對於 README.md 的格式，請遵循 中文文案排版指南。
• 確保英文和中文文檔始終保持最新；其他語言文檔的更新是可選的。

新增翻譯引擎

1. 在 pdf2zh/config/translate_engine_model.py 檔案中新增一個翻譯器配置類別。
2. 在相同檔案中，將新的翻譯器配置類別實例添加到 TRANSLATION_ENGINE_SETTING_TYPE 類型別名中。
3. 在 pdf2zh/translator/translator_impl 資料夾中新增翻譯器實作類別。

專案結構

• config 資料夾：配置系統。
• translator 資料夾：與翻譯器相關的實現。
• gui.py：提供 GUI 介面。
• const.py：一些常數。
• main.py：提供命令行工具。
• high_level.py：基於 BabelDOC 的高階介面。

• http_api.py：提供 HTTP API（尚未啟動）。

• Support for PDF to PDF, including text and mathematical formulas

• Support for LaTeX to LaTeX
• Support for Markdown to Markdown
• Support for plain text to plain text
• Support for multiple LLM services (OpenAI, DeepSeek, Aliyun, SiliconFlow, etc.)
• Support for multiple translation services (Google Translate, Microsoft Translator, etc.)
• Support for multiple file formats (PDF, LaTeX, Markdown, plain text)
• Support for multiple languages (English, Chinese, Japanese, Korean, etc.)
• Support for command line interface (CLI)
• Support for web user interface (WebUI)
• Support for batch processing
• Support for custom translation rules
• Support for custom output formats
• Support for custom language models
• Support for custom translation services
• Support for custom output directories
• Support for custom output file names
• Support for custom output file extensions
• Support for custom output file formats
• Support for custom output file encodings
• Support for custom output file line endings
• Support for custom output file indentation
• Support for custom output file spacing
• Support for custom output file margins
• Support for custom output file page breaks
• Support for custom output file headers and footers
• Support for custom output file watermarks
• Support for custom output file backgrounds
• Support for custom output file fonts
• Support for custom output file font sizes
• Support for custom output file font colors
• Support for custom output file font styles
• Support for custom output file font weights
• Support for custom output file font families
• Support for custom output file font variants
• Support for custom output file font stretches
• Support for custom output file font kerning
• Support for custom output file font ligatures
• Support for custom output file font features
• Support for custom output file font variations
• Support for custom output file font optical sizing
• Support for custom output file font display
• Support for custom output file font fallback
• Support for custom output file font synthesis
• Support for custom output file font size adjust
• Support for custom output file font smoothing
• Support for custom output file font rendering
• Support for custom output file font hinting
• Support for custom output file font subpixel rendering
• Support for custom output file font antialiasing
• Support for custom output file font grayscale
• Support for custom output file font subpixel antialiasing
• Support for custom output file font LCD rendering
• Support for custom output file font LCD filter
• Support for custom output file font LCD subpixel
• Support for custom output file font LCD vertical
• Support for custom output file font LCD horizontal
• Support for custom output file font LCD RGB
• Support for custom output file font LCD BGR
• Support for custom output file font LCD V RGB
• Support for custom output file font LCD V BGR
• Support for custom output file font LCD H RGB
• Support for custom output file font LCD H BGR
• Support for custom output file font LCD V
• Support for custom output file font LCD H
• Support for custom output file font LCD
• Support for custom output file font
• Support for custom output file
• Support for custom output
• Support for custom
• Support for

OUTPUT

請 AI 理解專案：DeepWiki - [x] 支援 PDF 轉 PDF，包括文字和數學公式 - [x] 支援 LaTeX 轉 LaTeX - [x] 支援 Markdown 轉 Markdown - [x] 支援純文字轉純文字 - [x] 支援多種 LLM 服務（OpenAI、DeepSeek、阿里雲、硅基流動等） - [x] 支援多種翻譯服務（Google Translate、Microsoft Translator 等） - [x] 支援多種檔案格式（PDF、LaTeX、Markdown、純文字） - [x] 支援多種語言（英文、中文、日文、韓文等） - [x] 支援命令行介面（CLI） - [x] 支援網頁使用者介面（WebUI） - [x] 支援批次處理 - [x] 支援自訂翻譯規則 - [x] 支援自訂輸出格式 - [x] 支援自訂語言模型 - [x] 支援自訂翻譯服務 - [x] 支援自訂輸出目錄 - [x] 支援自訂輸出檔案名稱 - [x] 支援自訂輸出檔案副檔名 - [x] 支援自訂輸出檔案格式 - [x] 支援自訂輸出檔案編碼 - [x] 支援自訂輸出檔案行尾符號 - [x] 支援自訂輸出檔案縮排 - [x] 支援自訂輸出檔案間距 - [x] 支援自訂輸出檔案邊距 - [x] 支援自訂輸出檔案分頁符 - [x] 支援自訂輸出檔案頁首和頁尾 - [x] 支援自訂輸出檔案浮水印 - [x] 支援自訂輸出檔案背景 - [x] 支援自訂輸出檔案字型 - [x] 支援自訂輸出檔案字型大小 - [x] 支援自訂輸出檔案字型顏色 - [x] 支援自訂輸出檔案字型樣式 - [x] 支援自訂輸出檔案字型粗細 - [x] 支援自訂輸出檔案字型家族 - [x] 支援自訂輸出檔案字型變體 - [x] 支援自訂輸出檔案字型拉伸 - [x] 支援自訂輸出檔案字型字距調整 - [x] 支援自訂輸出檔案字型連字 - [x] 支援自訂輸出檔案字型特性 - [x] 支援自訂輸出檔案字型變體 - [x] 支援自訂輸出檔案字型光學尺寸調整 - [x] 支援自訂輸出檔案字型顯示 - [x] 支援自訂輸出檔案字型後備 - [x] 支援自訂輸出檔案字型合成 - [x] 支援自訂輸出檔案字型大小調整 - [x] 支援自訂輸出檔案字型平滑 - [x] 支援自訂輸出檔案字型渲染 - [x] 支援自訂輸出檔案字型提示 - [x] 支援自訂輸出檔案字型子像素渲染 - [x] 支援自訂輸出檔案字型抗鋸齒 - [x] 支援自訂輸出檔案字型灰階 - [x] 支援自訂輸出檔案字型子像素抗鋸齒 - [x] 支援自訂輸出檔案字型 LCD 渲染 - [x] 支援自訂輸出檔案字型 LCD 濾鏡 - [x] 支援自訂輸出檔案字型 LCD 子像素 - [x] 支援自訂輸出檔案字型 LCD 垂直 - [x] 支援自訂輸出檔案字型 LCD 水平 - [x] 支援自訂輸出檔案字型 LCD RGB - [x] 支援自訂輸出檔案字型 LCD BGR - [x] 支援自訂輸出檔案字型 LCD V RGB - [x] 支援自訂輸出檔案字型 LCD V BGR - [x] 支援自訂輸出檔案字型 LCD H RGB - [x] 支援自訂輸出檔案字型 LCD H BGR - [x] 支援自訂輸出檔案字型 LCD V - [x] 支援自訂輸出檔案字型 LCD H - [x] 支援自訂輸出檔案字型 LCD - [x] 支援自訂輸出檔案字型 - [x] 支援自訂輸出檔案 - [x] 支援自訂輸出 - [x] 支援自訂 - [x] 支援

聯絡我們

如果您有任何疑問，請透過 Issue 提交反饋或加入我們的 Telegram 群組。感謝您的貢獻！