diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index fc07db9..76d420d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -67,7 +67,7 @@ jobs: mkdir -p translate node ./dist/index.js -i ./src/system.md -o ./translate/system-gpt-4o-en.md -l English --openai-url https://models.inference.ai.azure.com/chat/completions --api-key ${{ secrets.OPENAI_API_KEY }} --model gpt-4o node ./dist/index.js -i ./src/system.md -o ./translate/system-ministral-3b-ja.md -l Japanese --openai-url https://models.inference.ai.azure.com/chat/completions --api-key ${{ secrets.OPENAI_API_KEY }} --model Ministral-3B - node ./dist/index.js -i ./src/system.md -o ./translate/system-phi-3.5-mini-instruct-ko.md -l 朝鲜语 --openai-url https://models.inference.ai.azure.com/chat/completions --api-key ${{ secrets.OPENAI_API_KEY }} --model Phi-3.5-mini-instruct + node ./dist/index.js -i ./src/system.md -o ./translate/system-phi-3.5-mini-instruct-fr.md -l 法语 --openai-url https://models.inference.ai.azure.com/chat/completions --api-key ${{ secrets.OPENAI_API_KEY }} --model Phi-3.5-mini-instruct - name: Commit and Push run: | git add README-zh.md translate/ diff --git a/CHANGELOG.md b/CHANGELOG.md index 5116b1c..40dded6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ -## v1.0.10 +## v1.0.11 -[compare changes](https://github.com/h7ml/ai-markdown-translator/compare/v1.0.10...v1.0.10) +[compare changes](https://github.com/h7ml/ai-markdown-translator/compare/v1.0.11...v1.0.11) ### 💅 Refactors @@ -10,7 +10,7 @@ - **README:** Update README-zh.md ([8ceca79](https://github.com/h7ml/ai-markdown-translator/commit/8ceca79)) -- **release:** Update CHANGELOG for v1.0.10 [skip ci] ([d17947d](https://github.com/h7ml/ai-markdown-translator/commit/d17947d)) +- **release:** Update CHANGELOG for v1.0.11 [skip ci] ([d17947d](https://github.com/h7ml/ai-markdown-translator/commit/d17947d)) ### ❤️ Contributors @@ -19,7 +19,7 @@ ## v1.0.9 -[compare changes](https://github.com/h7ml/ai-markdown-translator/compare/v1.0.10...v1.0.9) +[compare changes](https://github.com/h7ml/ai-markdown-translator/compare/v1.0.11...v1.0.9) ### 📖 Documentation @@ -28,7 +28,7 @@ ### 🏡 Chore -- **release:** Update CHANGELOG for v1.0.10 [skip ci] ([d17947d](https://github.com/h7ml/ai-markdown-translator/commit/d17947d)) +- **release:** Update CHANGELOG for v1.0.11 [skip ci] ([d17947d](https://github.com/h7ml/ai-markdown-translator/commit/d17947d)) ### ❤️ Contributors diff --git a/README-zh.md b/README-zh.md index b893d5f..fb0165a 100644 --- a/README-zh.md +++ b/README-zh.md @@ -1,40 +1,36 @@ -以下是 `ai-markdown-translator` 文档的修订和整合版本，结合了 `npx` 和 `./ai-markdown-translator` 示例： - ---- - # ai-markdown-translator
- NPM version + NPM 版本 CI - Release - NPM Downloads - NPM License + 发布 + NPM 下载量 + NPM 许可证 GitHub Stars GitHub Issues GitHub Forks GitHub Contributors
-[English](README.md) | [中文](README-zh.md) +[英文](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 (v14 或更高版本) -- npm (通常与 Node.js 一起提供) +- Node.js (v14 或更高) +- npm (通常随 Node.js 一起安装) - OpenAI API 密钥 ## 安装 -1. 克隆这个仓库或下载源代码。 +1. 克隆此存储库或下载源代码。 2. 在终端中导航到项目目录。 3. 安装依赖： @@ -51,115 +47,115 @@ npm run build ## 脚本 - `build`: 将 TypeScript 文件编译为 JavaScript。 -- `start`: 使用 Node.js 运行编译后的 JavaScript。 +- `start`: 使用 Node.js 运行已编译的 JavaScript。 - `lint`: 运行 ESLint 检查 TypeScript 文件中的代码质量问题。 - `lint:fix`: 自动修复 TypeScript 文件中的 lint 问题。 -- `format`: 使用 Prettier 格式化 `src` 目录中的各种文件类型的代码。 +- `format`: 使用 Prettier 格式化 `src` 目录中的各种文件类型代码。 - `format:check`: 检查代码格式而不进行更改，适用于 `src` 目录中的各种文件类型。 - `postbuild`: 使编译后的 `index.js` 文件可执行。 -- `changelog`: 根据约定的提交生成变更日志。 -- `version`: 更新变更日志并在版本更新时为提交做准备。 +- `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`: 是否修改文件名。如果为真，则输出文件将命名为 `-translated.`。此选项允许您指定是否希望在翻译文件名中附加后缀。 +- `--rename`: 是否修改文件名。如果为真，输出文件将命名为 `<原始文件名>-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`: 显示帮助。此选项显示命令行工具的帮助信息。 - `--show-version`, `-v`: 显示版本。此选项显示工具的当前版本。 -> 注意：`--input` 和 `--url` 互斥；您必须提供其中一个。 +> 注意：`--input` 和 `--url` 是互斥的；你必须提供其中一个。 ## 环境变量 -您可以设置以下环境变量，而不是作为命令行参数传递它们： +你可以设置以下环境变量，而不是作为命令行参数传递它们： - `OPENAI_URL`: OpenAI API 的 URL。 -- `API_KEY`: 您的 OpenAI API 密钥。 +- `API_KEY`: 你的 OpenAI API 密钥。 - `MODEL`: 要使用的 OpenAI 模型（例如，`'gpt-3.5-turbo'`）。 -您可以在项目根目录下的 `.env` 文件中设置这些变量，或在您的 shell 中导出它们。 +你可以在项目根目录的 `.env` 文件中设置这些变量，或者在命令行中导出它们。 ## 示例 -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 密钥进行翻译：** ```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 文件并指定输出文件名：** +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 "日语" ``` ## 许可证 @@ -168,20 +164,20 @@ npx ai-markdown-translator -i example.md -o translated_example.md -l "Japanese" ## Git 信息 -- **仓库**: [h7ml/ai-markdown-translator](https://github.com/h7ml/ai-markdown-translator) +- **存储库**: [h7ml/ai-markdown-translator](https://github.com/h7ml/ai-markdown-translator) - **问题**: [报告问题](https://github.com/h7ml/ai-markdown-translator/issues) ## 版本信息 -- **当前版本**: 1.0.10 +- **当前版本**: 1.0.11 - **NPM 包**: [ai-markdown-translator](https://www.npmjs.com/package/ai-markdown-translator) ## CI 信息 -该项目使用 GitHub Actions 进行持续集成。CI 工作流包括： +该项目使用 GitHub Actions 进行持续集成。CI 工作流程包括： -- 使用 ESLint 检查代码 -- 运行测试（如适用） +- 使用 ESLint 对代码进行检测 +- 运行测试（如果适用） - 构建项目 - 缓存依赖以加快构建速度 @@ -191,8 +187,4 @@ npx ai-markdown-translator -i example.md -o translated_example.md -l "Japanese" ## 支持 -如果您遇到任何问题或有任何疑问，请在此仓库中打开一个问题。 - ---- - -此版本将 `npx` 和独立可执行文件 (`./ai-markdown-translator`) 的使用示例合并为一个统一的部分。如需进一步调整，请告诉我！ \ No newline at end of file +如果你遇到任何问题或有任何疑问，请在此存储库中提出问题。 diff --git a/README.md b/README.md index 97c451b..36fbffd 100644 --- a/README.md +++ b/README.md @@ -173,7 +173,7 @@ npx ai-markdown-translator -i example.md -o translated_example.md -l "Japanese" ## Version Information -- **Current Version**: 1.0.10 +- **Current Version**: 1.0.11 - **NPM Package**: [ai-markdown-translator](https://www.npmjs.com/package/ai-markdown-translator) ## CI Information diff --git a/package.json b/package.json index 572fce9..c5ce1ae 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ai-markdown-translator", - "version": "1.0.10", + "version": "1.0.11", "description": "CLI tool to translate Markdown files using OpenAI's language models while preserving the original formatting.", "main": "dist/index.js", "type": "module",