diff --git a/README-zh.md b/README-zh.md index 00c5832..1cc34e3 100644 --- a/README-zh.md +++ b/README-zh.md @@ -1,3 +1,7 @@ +以下是经过修订和整合的`ai-markdown-translator`文档,其中包含`npx`和`./ai-markdown-translator`的示例: + +--- + # ai-markdown-translator
@@ -14,23 +18,23 @@ [English](README.md) | [中文](README-zh.md) -`ai-markdown-translator` 是一个命令行工具,使用 OpenAI 的语言模型将 Markdown 文件从一种语言翻译成另一种语言。它在翻译内容的同时保留 Markdown 语法。 +`ai-markdown-translator` 是一个命令行工具,使用 OpenAI 的语言模型将 Markdown 文件从一种语言翻译为另一种语言。它在翻译内容时保持 Markdown 语法。 -## 特点 +## 特性 -- 将 Markdown 文件翻译为 OpenAI 模型支持的任何语言。 +- 将 Markdown 文件翻译成 OpenAI 模型支持的任何语言。 - 在翻译过程中保留 Markdown 语法。 -- 可通过命令行参数或环境变量进行灵活配置。 +- 通过命令行参数或环境变量进行灵活配置。 ## 先决条件 -- Node.js(v14 或更高版本) -- npm(通常与 Node.js 一起安装) +- Node.js (v14 或更高) +- npm (通常与 Node.js 一起安装) - OpenAI API 密钥 ## 安装 -1. 克隆此仓库或下载源代码。 +1. 克隆此代码库或下载源代码。 2. 在终端中导航到项目目录。 3. 安装依赖项: @@ -46,126 +50,126 @@ npm run build ## 脚本 -- `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`:构建项目并运行测试。 +- `build`: 将 TypeScript 文件编译为 JavaScript。 +- `start`: 使用 Node.js 运行编译后的 JavaScript。 +- `lint`: 使用 ESLint 检查 TypeScript 文件中的代码质量问题。 +- `lint:fix`: 自动修复 TypeScript 文件中的 linting 问题。 +- `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 <目标语言> [选项] ``` 例如: ```bash -npx ai-markdown-translator -u https://gitee.com/h7ml/ai-markdown-translator/raw/main/README.md -o output.md -l "Italian" +npx ai-markdown-translator -u https://gitee.com/h7ml/ai-markdown-translator/raw/main/README.md -o output.md -l "意大利语" ``` ### 使用独立可执行文件 ```bash -./ai-markdown-translator --input --output --language [options] +./ai-markdown-translator --input <输入文件> --output <输出文件> --language <目标语言> [选项] ``` ## 选项 -- `--input`,`-i`:输入的 Markdown 文件或目录(`--url` 的替代)。此选项允许您指定要翻译的 Markdown 文件或目录路径。 -- `--url`,`-u`:要翻译的 Markdown 文件的 URL(`--input` 的替代)。使用此选项提供要翻译的 Markdown 文件的直接链接。 +- `--input`, `-i`: 输入 Markdown 文件或目录(替代 `--url`)。此选项允许您指定要翻译的 Markdown 文件或目录的路径。 +- `--url`, `-u`: 要翻译的 Markdown 文件的 URL(替代 `--input`)。使用此选项提供您想要翻译的 Markdown 文件的直接链接。 -- `--extension`,`-e`:指定要翻译的文件扩展名(例如 `md`)。如果未提供,则处理所有文件。此选项允许您根据文件扩展名过滤要翻译的文件。 +- `--extension`, `-e`: 指定要翻译的文件扩展名(例如,`md`)。如果未提供,将处理所有文件。此选项允许您根据文件的扩展名过滤要翻译的文件。 -- `--rename`:是否修改文件名。如果为 true,输出文件将被命名为 `-translated.`。此选项允许您指定是否要在翻译文件名后附加后缀。 +- `--rename`: 是否修改文件名。如果为 true,则输出文件将命名为 `<原文件名>-translated.<扩展名>`。此选项允许您指定是否希望在翻译后的文件名后附加后缀。 -- `--output`,`-o`:输出 Markdown 文件(如果未提供,默认为输入文件名)。此选项允许您指定翻译内容将保存到的输出文件的名称。 +- `--output`, `-o`: 输出 Markdown 文件(如果未提供,默认为输入文件名)。此选项允许您指定保存翻译内容的输出文件的名称。 -- `--language`,`-l`:翻译的目标语言(必需)。此选项指定您希望将 Markdown 内容翻译成的语言。 +- `--language`, `-l`: 翻译的目标语言(必需)。此选项指定您希望将 Markdown 内容翻译成的语言。 -- `--openai-url`:OpenAI API URL(默认:使用 `OPENAI_URL` 环境变量)。此选项允许您在需要时指定 OpenAI API 的自定义 URL。 +- `--openai-url`: OpenAI API URL(默认:使用 `OPENAI_URL` 环境变量)。此选项允许您如有需要指定自定义的 OpenAI API URL。 -- `--api-key`:OpenAI API 密钥(默认:使用 `API_KEY` 环境变量)。此选项用于提供您的 OpenAI API 密钥进行身份验证。 +- `--api-key`: OpenAI API 密钥(默认:使用 `API_KEY` 环境变量)。此选项用于提供您的 OpenAI API 密钥以进行身份验证。 -- `--model`:要使用的 OpenAI 模型(默认:使用 `MODEL` 环境变量或 `gpt-3.5-turbo`)。此选项允许您指定要用于翻译的 OpenAI 模型。 +- `--model`: 要使用的 OpenAI 模型(默认:使用 `MODEL` 环境变量或 `gpt-3.5-turbo`)。此选项允许您指定要用于翻译的 OpenAI 模型。 -- `--help`,`-h`:显示帮助。此选项显示命令行工具的帮助信息。 +- `--help`, `-h`: 显示帮助。此选项显示命令行工具的帮助信息。 -- `--show-version`,`-v`:显示版本。此选项显示工具的当前版本。 +- `--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" +npx ai-markdown-translator -i english.md -o spanish.md -l "西班牙语" ``` -2. **使用特定的 OpenAI 模型进行翻译:** +2. **使用特定的 OpenAI 模型翻译:** ```bash -npx ai-markdown-translator -i input.md -o output.md -l "French" --model "gpt-4" +npx ai-markdown-translator -i input.md -o output.md -l "法语" --model "gpt-4" ``` -3. **使用自定义 OpenAI URL 和 API 密钥进行翻译:** +3. **使用自定义 OpenAI URL 和 API 密钥翻译:** ```bash -npx ai-markdown-translator -i input.md -o output.md -l "German" --openai-url "https://api.302.ai/v1/chat/completions" --api-key "sk-302-api-key" +npx ai-markdown-translator -i input.md -o output.md -l "德语" --openai-url "https://api.302.ai/v1/chat/completions" --api-key "sk-302-api-key" ``` 4. **翻译 URL 的 Markdown 内容:** ```bash -npx ai-markdown-translator -u https://gitee.com/h7ml/ai-markdown-translator/raw/main/README.md -o output.md -l "Italian" +npx ai-markdown-translator -u https://gitee.com/h7ml/ai-markdown-translator/raw/main/README.md -o output.md -l "意大利语" ``` -5. **翻译目录中的所有 Markdown 文件并重命名它们:** +5. **翻译目录中的所有 Markdown 文件并重命名:** ```bash -npx ai-markdown-translator -i ./markdown-files -l "Chinese" --rename +npx ai-markdown-translator -i ./markdown-files -l "中文" --rename ``` 6. **翻译 Markdown 文件并指定输出文件名:** ```bash -npx ai-markdown-translator -i example.md -o translated_example.md -l "Japanese" +npx ai-markdown-translator -i example.md -o translated_example.md -l "日语" ``` ## 许可证 -[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) ## 版本信息 @@ -176,10 +180,10 @@ npx ai-markdown-translator -i example.md -o translated_example.md -l "Japanese" 该项目使用 GitHub Actions 进行持续集成。CI 工作流包括: -- 使用 ESLint 对代码进行 lint 检查 -- 运行测试(如适用) +- 使用 ESLint 对代码进行 linting +- 运行测试(如果适用) - 构建项目 -- 为更快的构建缓存依赖项 +- 缓存依赖项以加快构建速度 ## 贡献 @@ -187,4 +191,8 @@ npx ai-markdown-translator -i example.md -o translated_example.md -l "Japanese" ## 支持 -如果您遇到任何问题或有任何疑问,请在此仓库中打开一个问题。 +如果您遇到任何问题或有任何疑问,请在此代码库中提交问题。 + +--- + +这个版本将 `npx` 和独立可执行文件(`./ai-markdown-translator`)的使用示例整合为一个统一的部分。如果您希望进行任何进一步的调整,请告诉我! \ No newline at end of file