diff --git a/docs/advanced/advanced.md b/docs/advanced/advanced.md index 6c742e022..76e6f2383 100644 --- a/docs/advanced/advanced.md +++ b/docs/advanced/advanced.md @@ -75,7 +75,7 @@ In the following table, we list all advanced options for reference: |----------------------------------|--------------------------------------------|-------------------------------------------------| | `--share` | Enable sharing mode | `pdf2zh --gui --share` | | `--auth-file` | Path to the authentication file | `pdf2zh --gui --auth-file /path` | -| `--enabled-services` | Enabled translation services | `pdf2zh --gui --enabled-services "OpenAI"` | +| `--enabled-services` | Enabled translation services | `pdf2zh --gui --enabled-services "Bing,OpenAI"` | | `--disable-gui-sensitive-input` | Disable GUI sensitive input | `pdf2zh --gui --disable-gui-sensitive-input` | | `--disable-config-auto-save` | Disable automatic configuration saving | `pdf2zh --gui --disable-config-auto-save` | diff --git a/docs/community/Contribution-Guide.md b/docs/community/Contribution-Guide.md index b593f514e..0236ea0cd 100644 --- a/docs/community/Contribution-Guide.md +++ b/docs/community/Contribution-Guide.md @@ -56,7 +56,7 @@ - 如果引入了新的依赖,请及时更新 `pyproject.toml` 文件中的依赖列表。 5. **文档更新** - - 如果添加了新的命令行选项,请同步更新多语言版本的 `README.md` 文件中的命令行选项列表。 + - 如果添加了新的命令行选项,请同步更新对应文档。 6. **提交信息** - 使用 [语义化提交信息](https://www.conventionalcommits.org/zh-hans/v1.0.0/),例如:`feat(translator): add openai`。 diff --git a/docs/getting-started/INSTALLATION_docker.md b/docs/getting-started/INSTALLATION_docker.md index f0c086615..e96ad5863 100644 --- a/docs/getting-started/INSTALLATION_docker.md +++ b/docs/getting-started/INSTALLATION_docker.md @@ -17,6 +17,15 @@ docker run -d -p 7860:7860 byaidu/pdf2zh ``` +> [!WARNING] +> +> - If you cannot access Docker Hub, please try the image on [GitHub Container Registry](https://github.com/Byaidu/PDFMathTranslate/pkgs/container/pdfmathtranslate). +> +> ```bash +> docker pull ghcr.io/byaidu/pdfmathtranslate +> docker run -d -p 7860:7860 ghcr.io/byaidu/pdfmathtranslate +> ``` + 2. Enter this URL in your default browser to open the WebUI page: ``` http://localhost:7860/ diff --git a/docs/getting-started/USAGE_commandline.md b/docs/getting-started/USAGE_commandline.md index 4801ba6fe..dbde1d70d 100644 --- a/docs/getting-started/USAGE_commandline.md +++ b/docs/getting-started/USAGE_commandline.md @@ -40,15 +40,6 @@ After execute translation, files generated in **current working directory**. > > After executing this command, a pathname will be output. This pathname is the "**Current working directory**". The translated files will appear here. -> [!WARNING] -> -> - If you cannot access Docker Hub, please try the image on [GitHub Container Registry](https://github.com/Byaidu/PDFMathTranslate/pkgs/container/pdfmathtranslate). -> -> ```bash -> docker pull ghcr.io/byaidu/pdfmathtranslate -> docker run -d -p 7860:7860 ghcr.io/byaidu/pdfmathtranslate -> ``` - --- #### Advance Usage