Skip to content

docs: 📝 update doc #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
awwaawwa merged 1 commit into from
Jun 4, 2025
Merged

docs: 📝 update doc #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/advanced/advanced.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` |

Expand Down
2 changes: 1 addition & 1 deletion docs/community/Contribution-Guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
- 如果引入了新的依赖，请及时更新 `pyproject.toml` 文件中的依赖列表。

5. **文档更新**
- 如果添加了新的命令行选项，请同步更新多语言版本的 `README.md` 文件中的命令行选项列表。
- 如果添加了新的命令行选项，请同步更新对应文档。

6. **提交信息**
- 使用 [语义化提交信息](https://www.conventionalcommits.org/zh-hans/v1.0.0/)，例如：`feat(translator): add openai`。
Expand Down
9 changes: 9 additions & 0 deletions docs/getting-started/INSTALLATION_docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
9 changes: 0 additions & 9 deletions docs/getting-started/USAGE_commandline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading