Merge pull request #5 from h7ml/dev

docs(README): 更新 README-zh.md 和 README.md

.github/workflows/ci.yml

@@ -63,6 +63,16 @@ jobs:
         run: |
           pnpm test || (echo "Test failed" && exit 1)
 
+      - name: Commit and Push
+        run: |
+          git add README-zh.md
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+          git config advice.ignoredHook false
+          git commit -m "docs(README): update README-zh.md"
+          BRANCH=$(echo "${GITHUB_REF}" | sed 's@refs/heads/@@')
+          git push origin HEAD:$BRANCH || echo "Push to repository failed"
+
       - name: Upload build artifacts
         uses: actions/upload-artifact@v3
         with:

README-zh.md

@@ -1,39 +1,41 @@
-这是 `ai-markdown-translator` 文档的修订和合并版本，将 `npx` 和 `./ai-markdown-translator` 的示例结合在一起：
+以下是“ai-markdown-translator”文档的修订和合并版本，其中结合了`npx`和`./ai-markdown-translator`示例：
 
 ---
 
 # ai-markdown-translator
 
-[![NPM 版本](https://img.shields.io/npm/v/ai-markdown-translator.svg?style=flat)](https://www.npmjs.org/package/ai-markdown-translator)  
-[![CI](https://github.com/h7ml/ai-markdown-translator/actions/workflows/ci.yml/badge.svg)](https://github.com/h7ml/ai-markdown-translator/actions/workflows/ci.yml)  
-[![Release](https://github.com/h7ml/ai-markdown-translator/actions/workflows/release.yml/badge.svg)](https://github.com/h7ml/ai-markdown-translator/actions/workflows/release.yml)  
-[![NPM 下载量](https://img.shields.io/npm/dw/ai-markdown-translator)](https://www.npmjs.org/package/ai-markdown-translator)  
-[![NPM 许可证](https://img.shields.io/npm/l/ai-markdown-translator)](https://www.npmjs.org/package/ai-markdown-translator)
-[![GitHub Stars](https://img.shields.io/github/stars/h7ml/ai-markdown-translator.svg)](https://github.com/h7ml/ai-markdown-translator/stargazers)  
-[![GitHub Issues](https://img.shields.io/github/issues/h7ml/ai-markdown-translator.svg)](https://github.com/h7ml/ai-markdown-translator/issues)  
-[![GitHub Forks](https://img.shields.io/github/forks/h7ml/ai-markdown-translator.svg)](https://github.com/h7ml/ai-markdown-translator/network/members)  
-[![GitHub Contributors](https://img.shields.io/github/contributors/h7ml/ai-markdown-translator.svg)](https://github.com/h7ml/ai-markdown-translator/graphs/contributors)
+<div>
+  <a href="https://www.npmjs.org/package/ai-markdown-translator"><img src="https://img.shields.io/npm/v/ai-markdown-translator.svg?style=flat" alt="NPM 版本"></a>
+  <a href="https://github.com/h7ml/ai-markdown-translator/actions/workflows/ci.yml"><img src="https://github.com/h7ml/ai-markdown-translator/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://github.com/h7ml/ai-markdown-translator/actions/workflows/release.yml"><img src="https://github.com/h7ml/ai-markdown-translator/actions/workflows/release.yml/badge.svg" alt="发布"></a>
+  <a href="https://www.npmjs.org/package/ai-markdown-translator"><img src="https://img.shields.io/npm/dw/ai-markdown-translator" alt="NPM 下载量"></a>
+  <a href="https://www.npmjs.org/package/ai-markdown-translator"><img src="https://img.shields.io/npm/l/ai-markdown-translator" alt="NPM 许可证"></a>
+  <a href="https://github.com/h7ml/ai-markdown-translator/stargazers"><img src="https://img.shields.io/github/stars/h7ml/ai-markdown-translator.svg" alt="GitHub 星标"></a>
+  <a href="https://github.com/h7ml/ai-markdown-translator/issues"><img src="https://img.shields.io/github/issues/h7ml/ai-markdown-translator.svg" alt="GitHub 问题"></a>
+  <a href="https://github.com/h7ml/ai-markdown-translator/network/members"><img src="https://img.shields.io/github/forks/h7ml/ai-markdown-translator.svg" alt="GitHub 分叉"></a>
+  <a href="https://github.com/h7ml/ai-markdown-translator/graphs/contributors"><img src="https://img.shields.io/github/contributors/h7ml/ai-markdown-translator.svg" alt="GitHub 贡献者"></a>
+</div>
 
 [English](README.md) | [中文](README-zh.md)
 
-`ai-markdown-translator` 是一个命令行工具，可以使用 OpenAI 的语言模型将 Markdown 文件从一种语言翻译成另一种语言。它在翻译内容的同时保留了 Markdown 语法。
+`ai-markdown-translator` 是一个命令行工具，使用 OpenAI 的语言模型将 Markdown 文件从一种语言翻译成另一种语言。它在翻译内容的同时保持 Markdown 语法不变。
 
 ## 功能
 
 - 将 Markdown 文件翻译为 OpenAI 模型支持的任何语言。
-- 在翻译过程中保留 Markdown 语法。
-- 通过命令行参数或环境变量进行灵活配置。
+- 在翻译过程中保持 Markdown 语法不变。
+- 通过命令行参数或环境变量灵活配置。
 
 ## 先决条件
 
-- Node.js (v14 或更高版本)
-- npm (通常随 Node.js 一起安装)
+- Node.js（版本14或更高）
+- npm（通常随 Node.js 一起提供）
 - 一个 OpenAI API 密钥
 
 ## 安装
 
 1. 克隆此存储库或下载源代码。
-2. 在终端中导航到项目目录。
+2. 在终端中进入项目目录。
 3. 安装依赖项：
 
 ```bash
@@ -50,18 +52,18 @@ npm run build
 
 - `build`: 将 TypeScript 文件编译为 JavaScript。
 - `start`: 使用 Node.js 运行编译后的 JavaScript。
-- `lint`: 使用 ESLint 检查 TypeScript 文件中的代码质量问题。
+- `lint`: 运行 ESLint 检查 TypeScript 文件中的代码质量问题。
 - `lint:fix`: 自动修复 TypeScript 文件中的 lint 问题。
 - `format`: 使用 Prettier 格式化 `src` 目录中各种文件类型的代码。
-- `format:check`: 检查代码格式而不对 `src` 目录中各种文件类型进行更改。
+- `format:check`: 检查代码格式而不进行更改。
 - `postbuild`: 使编译后的 `index.js` 文件可执行。
-- `changelog`: 根据常规提交生成更改日志。
-- `version`: 在版本控制时更新更改日志并将其暂存为提交。
+- `changelog`: 基于惯例提交生成变更日志。
+- `version`: 更新变更日志并在版本控制时准备提交。
 - `test`: 构建项目并运行测试。
 
-## 使用方法
+## 用法
 
-您可以使用 Node.js、`npx` 或作为独立可执行文件（如果已打包）来运行 CLI 工具。
+可以使用 Node.js、`npx` 或作为独立可执行文件（如果已打包）运行 CLI 工具。
 
 ### 使用 Node.js
 
@@ -89,37 +91,37 @@ npx ai-markdown-translator -u https://gitee.com/h7ml/ai-markdown-translator/raw/
 
 ## 选项
 
-- `--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`）。
+- `--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'`）。
+- `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"
 ```
 
-2. **使用特定 OpenAI 模型进行翻译：**
+2. **使用特定的 OpenAI 模型进行翻译：**
 
 ```bash
 npx ai-markdown-translator -i input.md -o output.md -l "French" --model "gpt-4"
@@ -153,21 +155,21 @@ npx ai-markdown-translator -u https://gitee.com/h7ml/ai-markdown-translator/raw/
 
 ## CI 信息
 
-该项目使用 GitHub Actions 进行持续集成。CI 工作流包括：
+此项目使用 GitHub Actions 进行持续集成。CI 工作流包括：
 
-- 使用 ESLint 对代码进行 lint 检查
-- 运行测试（如适用）
+- 使用 ESLint 检查代码
+- 运行测试（如果适用）
 - 构建项目
 - 缓存依赖项以加快构建速度
 
 ## 贡献
 
-欢迎贡献！请随时提交 Pull Request。
+欢迎贡献！请随时提交拉取请求。
 
 ## 支持
 
-如果遇到任何问题或有任何问题，请在此存储库中打开一个问题。
+如果遇到任何问题或有任何问题，请在此存储库中提出问题。
 
 ---
 
-此版本将 `npx` 和独立可执行文件 (`./ai-markdown-translator`) 的使用示例合并到一个连贯的部分中。如需进一步调整，请告诉我！
+此版本结合了 `npx` 和独立可执行文件（`./ai-markdown-translator`）的使用示例，让我知道您是否希望做进一步的调整！

README.md

@@ -4,15 +4,17 @@ Here’s the revised and consolidated version of the `ai-markdown-translator` do
 
 # ai-markdown-translator
 
-[![NPM version](https://img.shields.io/npm/v/ai-markdown-translator.svg?style=flat)](https://www.npmjs.org/package/ai-markdown-translator)  
-[![CI](https://github.com/h7ml/ai-markdown-translator/actions/workflows/ci.yml/badge.svg)](https://github.com/h7ml/ai-markdown-translator/actions/workflows/ci.yml)  
-[![Release](https://github.com/h7ml/ai-markdown-translator/actions/workflows/release.yml/badge.svg)](https://github.com/h7ml/ai-markdown-translator/actions/workflows/release.yml)  
-[![NPM Downloads](https://img.shields.io/npm/dw/ai-markdown-translator)](https://www.npmjs.org/package/ai-markdown-translator)  
-[![NPM License](https://img.shields.io/npm/l/ai-markdown-translator)](https://www.npmjs.org/package/ai-markdown-translator)
-[![GitHub Stars](https://img.shields.io/github/stars/h7ml/ai-markdown-translator.svg)](https://github.com/h7ml/ai-markdown-translator/stargazers)  
-[![GitHub Issues](https://img.shields.io/github/issues/h7ml/ai-markdown-translator.svg)](https://github.com/h7ml/ai-markdown-translator/issues)  
-[![GitHub Forks](https://img.shields.io/github/forks/h7ml/ai-markdown-translator.svg)](https://github.com/h7ml/ai-markdown-translator/network/members)  
-[![GitHub Contributors](https://img.shields.io/github/contributors/h7ml/ai-markdown-translator.svg)](https://github.com/h7ml/ai-markdown-translator/graphs/contributors)
+<div>
+  <a href="https://www.npmjs.org/package/ai-markdown-translator"><img src="https://img.shields.io/npm/v/ai-markdown-translator.svg?style=flat" alt="NPM version"></a>
+  <a href="https://github.com/h7ml/ai-markdown-translator/actions/workflows/ci.yml"><img src="https://github.com/h7ml/ai-markdown-translator/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://github.com/h7ml/ai-markdown-translator/actions/workflows/release.yml"><img src="https://github.com/h7ml/ai-markdown-translator/actions/workflows/release.yml/badge.svg" alt="Release"></a>
+  <a href="https://www.npmjs.org/package/ai-markdown-translator"><img src="https://img.shields.io/npm/dw/ai-markdown-translator" alt="NPM Downloads"></a>
+  <a href="https://www.npmjs.org/package/ai-markdown-translator"><img src="https://img.shields.io/npm/l/ai-markdown-translator" alt="NPM License"></a>
+  <a href="https://github.com/h7ml/ai-markdown-translator/stargazers"><img src="https://img.shields.io/github/stars/h7ml/ai-markdown-translator.svg" alt="GitHub Stars"></a>
+  <a href="https://github.com/h7ml/ai-markdown-translator/issues"><img src="https://img.shields.io/github/issues/h7ml/ai-markdown-translator.svg" alt="GitHub Issues"></a>
+  <a href="https://github.com/h7ml/ai-markdown-translator/network/members"><img src="https://img.shields.io/github/forks/h7ml/ai-markdown-translator.svg" alt="GitHub Forks"></a>
+  <a href="https://github.com/h7ml/ai-markdown-translator/graphs/contributors"><img src="https://img.shields.io/github/contributors/h7ml/ai-markdown-translator.svg" alt="GitHub Contributors"></a>
+</div>
 
 [English](README.md) | [中文](README-zh.md)