diff --git a/docs/advanced/advanced.md b/docs/advanced/advanced.md index 76e6f2383..d4e1001dc 100644 --- a/docs/advanced/advanced.md +++ b/docs/advanced/advanced.md @@ -23,7 +23,7 @@ Execute the translation command in the command line to generate the translated document `example-mono.pdf` and the bilingual document `example-dual.pdf` in the current working directory. Use Google as the default translation service. More support translation services can find [HERE](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#services). -cmd +cmd In the following table, we list all advanced options for reference: @@ -201,7 +201,7 @@ For example, if you want to enable a GUI window, you can use the following comma PDF2ZH_GUI=TRUE pdf2zh ``` -env +env - User-Specified **Configuration File** diff --git a/docs/community/Contribution-Guide.md b/docs/community/Contribution-Guide.md index 0236ea0cd..f88257163 100644 --- a/docs/community/Contribution-Guide.md +++ b/docs/community/Contribution-Guide.md @@ -41,31 +41,46 @@ ## 基本要求 -1. **工作流程** +

1. 工作流程

+ - 请在 `main` 主分支上创建 fork，并在 fork 的分支上进行开发。 - 提交 Pull Request (PR) 时，请对提交的内容进行详细说明。 - 如果 PR 没有通过自动化检查（提示 `checks failed` 和红色叉号标记），请查看相应的 `details` 并修改提交内容，确保新的 PR 可以通过自动化检查。 -2. **开发和测试** + +

2. 开发和测试

+ - 使用 `pip install -e .` 命令进行开发和测试。 -3. **代码格式化** + +

3. 代码格式化

+ - 配置 `pre-commit` 工具，启用 `black` 和 `flake8` 进行代码格式化。 -4. **依赖更新** + +

4. 依赖更新

+ - 如果引入了新的依赖，请及时更新 `pyproject.toml` 文件中的依赖列表。 -5. **文档更新** - - 如果添加了新的命令行选项，请同步更新对应文档。 -6. **提交信息** +

5. 文档更新

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

6. 提交信息

+ - 使用 [语义化提交信息](https://www.conventionalcommits.org/zh-hans/v1.0.0/)，例如：`feat(translator): add openai`。 -7. **编码风格** + +

7. 编码风格

+ - 请确保提交的代码符合基本的编码风格规范。 - 变量命名请使用下划线或驼峰命名法。 -8. **文档排版** + +

8. 文档排版

+ - `README.md` 文件的排版请遵循 [中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines)。 - 确保英文和中文文档始终保持最新状态，其它语言文档为可选更新。 diff --git a/docs/images/cmd_dark.svg b/docs/images/cmd_dark.svg new file mode 100644 index 000000000..ed3249179 --- /dev/null +++ b/docs/images/cmd_dark.svg @@ -0,0 +1,1900 @@ + + + + diff --git a/docs/images/cmd_light.svg b/docs/images/cmd_light.svg new file mode 100644 index 000000000..e7ace831e --- /dev/null +++ b/docs/images/cmd_light.svg @@ -0,0 +1,1793 @@ + + + + diff --git a/docs/images/ev_dark.svg b/docs/images/ev_dark.svg new file mode 100644 index 000000000..b2a8e14e1 --- /dev/null +++ b/docs/images/ev_dark.svg @@ -0,0 +1,2134 @@ + + + + diff --git a/docs/images/ev_light.svg b/docs/images/ev_light.svg new file mode 100644 index 000000000..b48441c3d --- /dev/null +++ b/docs/images/ev_light.svg @@ -0,0 +1,2044 @@ + + + +