From 74b3682e144869d1cbabd42bf23a9d1e061ce3c7 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Sat, 14 Dec 2024 05:17:34 +0000 Subject: [PATCH] docs(README): update README-zh.md --- README-zh.md | 102 +++++++++++++++++++++++++-------------------------- 1 file changed, 51 insertions(+), 51 deletions(-) diff --git a/README-zh.md b/README-zh.md index b2c16c6..d3092c5 100644 --- a/README-zh.md +++ b/README-zh.md @@ -1,4 +1,4 @@ -以下是“ai-markdown-translator”文档的修订和合并版本，其中结合了`npx`和`./ai-markdown-translator`示例： +以下是经过修订和合并的 `ai-markdown-translator` 文档版本，包含 `npx` 和 `./ai-markdown-translator` 示例： --- @@ -12,30 +12,30 @@ NPM 许可证 GitHub 星标 GitHub 问题 - GitHub 分叉 + GitHub Forks GitHub 贡献者 [English](README.md) | [中文](README-zh.md) -`ai-markdown-translator` 是一个命令行工具，使用 OpenAI 的语言模型将 Markdown 文件从一种语言翻译成另一种语言。它在翻译内容的同时保持 Markdown 语法不变。 +`ai-markdown-translator` 是一个命令行工具，可以使用 OpenAI 的语言模型将 Markdown 文件从一种语言翻译成另一种语言。它在翻译内容的同时，保留了 Markdown 语法。 -## 功能 +## 特性 -- 将 Markdown 文件翻译为 OpenAI 模型支持的任何语言。 -- 在翻译过程中保持 Markdown 语法不变。 +- 将 Markdown 文件翻译成 OpenAI 模型支持的任何语言。 +- 在翻译过程中保留 Markdown 语法。 - 通过命令行参数或环境变量灵活配置。 ## 先决条件 -- Node.js（版本14或更高） -- npm（通常随 Node.js 一起提供） +- Node.js（v14 或更高版本） +- npm（通常与 Node.js 一起安装） - 一个 OpenAI API 密钥 ## 安装 -1. 克隆此存储库或下载源代码。 -2. 在终端中进入项目目录。 +1. 克隆此库或下载源代码。 +2. 在终端中导航到项目目录。 3. 安装依赖项： ```bash @@ -50,31 +50,31 @@ npm run build ## 脚本 -- `build`: 将 TypeScript 文件编译为 JavaScript。 -- `start`: 使用 Node.js 运行编译后的 JavaScript。 -- `lint`: 运行 ESLint 检查 TypeScript 文件中的代码质量问题。 -- `lint:fix`: 自动修复 TypeScript 文件中的 lint 问题。 -- `format`: 使用 Prettier 格式化 `src` 目录中各种文件类型的代码。 -- `format:check`: 检查代码格式而不进行更改。 -- `postbuild`: 使编译后的 `index.js` 文件可执行。 -- `changelog`: 基于惯例提交生成变更日志。 -- `version`: 更新变更日志并在版本控制时准备提交。 -- `test`: 构建项目并运行测试。 +- `build`：将 TypeScript 文件编译为 JavaScript。 +- `start`：使用 Node.js 运行编译后的 JavaScript。 +- `lint`：运行 ESLint 检查 TypeScript 文件中的代码质量问题。 +- `lint:fix`：自动修复 TypeScript 文件中的 lint 问题。 +- `format`：使用 Prettier 格式化 `src` 目录中的各种文件类型代码。 +- `format:check`：检查代码格式而不进行更改，适用于 `src` 目录中的各种文件类型。 +- `postbuild`：使编译后的 `index.js` 文件可执行。 +- `changelog`：根据约定的提交生成变更日志。 +- `version`：在版本控制时更新变更日志并将其暂存以供提交。 +- `test`：构建项目并运行测试。 ## 用法 -可以使用 Node.js、`npx` 或作为独立可执行文件（如果已打包）运行 CLI 工具。 +您可以使用 Node.js、`npx` 或作为独立可执行文件（如果您已将其打包）来运行 CLI 工具。 ### 使用 Node.js ```bash -node dist/index.js --input --output --language [options] +node dist/index.js --input <输入文件> --output <输出文件> --language <目标语言> [选项] ``` ### 使用 npx ```bash -npx ai-markdown-translator -i -o -l [options] +npx ai-markdown-translator -i <输入文件> -o <输出文件> -l <目标语言> [选项] ``` 例如： @@ -86,36 +86,36 @@ npx ai-markdown-translator -u https://gitee.com/h7ml/ai-markdown-translator/raw/ ### 使用独立可执行文件 ```bash -./ai-markdown-translator --input --output --language [options] +./ai-markdown-translator --input <输入文件> --output <输出文件> --language <目标语言> [选项] ``` ## 选项 -- `--input`, `-i`: 输入 Markdown 文件（`--url` 的替代选项）。 -- `--url`, `-u`: 要翻译的 Markdown 文件的 URL（`--input` 的替代选项）。 -- `--output`, `-o`: 输出 Markdown 文件（必需）。 -- `--language`, `-l`: 翻译目标语言（必需）。 -- `--openai-url`: OpenAI API URL（默认：使用 `OPENAI_URL` 环境变量）。 -- `--api-key`: OpenAI API 密钥（默认：使用 `API_KEY` 环境变量）。 -- `--model`: 要使用的 OpenAI 模型（默认：使用 `MODEL` 环境变量或 `gpt-3.5-turbo`）。 -- `--help`, `-h`: 显示帮助。 -- `--show-version`, `-v`: 显示版本。 +- `--input`, `-i`：输入 Markdown 文件（可替代 `--url`）。 +- `--url`, `-u`：要翻译的 Markdown 文件的 URL（可替代 `--input`）。 +- `--output`, `-o`：输出 Markdown 文件（必需）。 +- `--language`, `-l`：翻译的目标语言（必需）。 +- `--openai-url`：OpenAI API URL（默认使用 `OPENAI_URL` 环境变量）。 +- `--api-key`：OpenAI API 密钥（默认使用 `API_KEY` 环境变量）。 +- `--model`：要使用的 OpenAI 模型（默认使用 `MODEL` 环境变量或 `gpt-3.5-turbo`）。 +- `--help`, `-h`：显示帮助信息。 +- `--show-version`, `-v`：显示版本。 -> 注意：`--input` 和 `--url` 是互斥的，你必须提供其中之一。 +> 注意：`--input` 和 `--url` 是互斥的；您必须提供其中一个。 ## 环境变量 -可以设置以下环境变量，而不是将它们作为命令行参数传递： +您可以设置以下环境变量，而不是作为命令行参数传递： -- `OPENAI_URL`: OpenAI API 的 URL。 -- `API_KEY`: 你的 OpenAI API 密钥。 -- `MODEL`: 要使用的 OpenAI 模型（例如，`'gpt-3.5-turbo'`）。 +- `OPENAI_URL`：OpenAI API 的 URL。 +- `API_KEY`：您的 OpenAI API 密钥。 +- `MODEL`：要使用的 OpenAI 模型（例如，`'gpt-3.5-turbo'`）。 -可以在项目根目录中的 `.env` 文件中设置这些变量，或者在你的 shell 中导出它们。 +您可以在项目根目录中的 `.env` 文件中设置这些变量，或在您的 shell 中导出它们。 ## 示例 -1. **将 Markdown 文件从英语翻译为西班牙语：** +1. **将 Markdown 文件从英语翻译成西班牙语：** ```bash npx ai-markdown-translator -i english.md -o spanish.md -l "Spanish" @@ -141,35 +141,35 @@ npx ai-markdown-translator -u https://gitee.com/h7ml/ai-markdown-translator/raw/ ## 许可证 -[MIT License](LICENSE) +[MIT 许可证](LICENSE) ## Git 信息 -- **仓库**: [h7ml/ai-markdown-translator](https://github.com/h7ml/ai-markdown-translator) -- **问题**: [报告问题](https://github.com/h7ml/ai-markdown-translator/issues) +- **仓库**：[h7ml/ai-markdown-translator](https://github.com/h7ml/ai-markdown-translator) +- **问题**：[报告问题](https://github.com/h7ml/ai-markdown-translator/issues) ## 版本信息 -- **当前版本**: 1.0.6 -- **NPM 包**: [ai-markdown-translator](https://www.npmjs.com/package/ai-markdown-translator) +- **当前版本**：1.0.6 +- **NPM 包**：[ai-markdown-translator](https://www.npmjs.com/package/ai-markdown-translator) ## CI 信息 -此项目使用 GitHub Actions 进行持续集成。CI 工作流包括： +该项目使用 GitHub Actions 进行持续集成。CI 工作流包括： -- 使用 ESLint 检查代码 -- 运行测试（如果适用） +- 使用 ESLint 对代码进行 lint 检查 +- 运行测试（如适用） - 构建项目 - 缓存依赖项以加快构建速度 ## 贡献 -欢迎贡献！请随时提交拉取请求。 +欢迎贡献！请随时提交 Pull Request。 ## 支持 -如果遇到任何问题或有任何问题，请在此存储库中提出问题。 +如果您遇到任何问题或有任何疑问，请在此仓库中提出问题。 --- -此版本结合了 `npx` 和独立可执行文件（`./ai-markdown-translator`）的使用示例，让我知道您是否希望做进一步的调整！ \ No newline at end of file +此版本将 `npx` 和独立可执行文件（`./ai-markdown-translator`）的用法示例合并为一个一致的部分。如果您希望进行进一步调整，请告诉我！ \ No newline at end of file