Skip to content

Commit

Permalink
docs(README): 更新版本号并优化文档格式
Browse files Browse the repository at this point in the history
- 将版本号从 1.0.6 升级到 1.0.7
- 优化了 README-zh.md 和 README.md 的格式和内容
- 更新了 package.json 中的版本号
  • Loading branch information
h7ml committed Dec 14, 2024
1 parent 4bc6f4b commit ff29d06
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 39 deletions.
74 changes: 37 additions & 37 deletions README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,19 @@

[English](README.md) | [中文](README-zh.md)

`ai-markdown-translator` 是一个命令行工具,能利用OpenAI的语言模型将Markdown文件从一种语言翻译成另一种语言。它在翻译内容的同时保持了Markdown语法的完整性
`ai-markdown-translator` 是一个命令行工具,能利用 OpenAI 的语言模型将 Markdown 文件从一种语言翻译成另一种语言。它在翻译内容的同时保持了 Markdown 语法的完整性

## 特性

- 使用OpenAI的模型将Markdown文件翻译成任何受支持的语言
- 在翻译过程中保持Markdown语法
- 使用 OpenAI 的模型将 Markdown 文件翻译成任何受支持的语言
- 在翻译过程中保持 Markdown 语法
- 通过命令行参数或环境变量灵活配置。

## 先决条件

- Node.js(v14或更高版本
- npm(通常与Node.js一起提供
- OpenAI API密钥
- Node.js(v14 或更高版本
- npm(通常与 Node.js 一起提供
- OpenAI API 密钥

## 安装

Expand All @@ -50,11 +50,11 @@ npm run build

## 脚本

- `build`将TypeScript文件编译成JavaScript
- `start`使用Node.js运行编译的JavaScript
- `lint`运行ESLint以检查 TypeScript 文件中的代码质量问题。
- `lint:fix`:自动修复 TypeScript 文件中的linting问题
- `format`使用Prettier格式化`src`目录中多种文件类型的代码。
- `build`将 TypeScript 文件编译成 JavaScript
- `start`使用 Node.js 运行编译的 JavaScript
- `lint`运行 ESLint 以检查 TypeScript 文件中的代码质量问题。
- `lint:fix`:自动修复 TypeScript 文件中的 linting 问题
- `format`使用 Prettier 格式化`src`目录中多种文件类型的代码。
- `format:check`:检查代码格式,但不进行修改`src`目录中多种文件类型的代码。
- `postbuild`:使编译的`index.js`文件可执行。
- `changelog`:基于常规提交生成更新日志。
Expand All @@ -63,15 +63,15 @@ npm run build

## 使用方法

你可以使用Node.js、`npx`或者作为独立的可执行文件运行CLI工具(如果你打包过它)。
你可以使用 Node.js、`npx`或者作为独立的可执行文件运行 CLI 工具(如果你打包过它)。

### 使用Node.js
### 使用 Node.js

```bash
node dist/index.js --input <输入文件> --output <输出文件> --language <目标语言> [选项]
```

### 使用npx
### 使用 npx

```bash
npx ai-markdown-translator -i <输入文件> -o <输出文件> -l <目标语言> [选项]
Expand All @@ -91,13 +91,13 @@ 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文件(如果未提供,则默认为输入文件名)。
- `--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`)。
- `--api-key`:OpenAI API 密钥 (默认:使用 `API_KEY` 环境变量)。
- `--model`要使用的 OpenAI 模型 (默认:使用 `MODEL` 环境变量或 `gpt-3.5-turbo`)。
- `--help`, `-h`:显示帮助。
- `--show-version`, `-v`:显示版本。

Expand All @@ -107,69 +107,69 @@ npx ai-markdown-translator -u https://gitee.com/h7ml/ai-markdown-translator/raw/

你可以设置以下环境变量,而不是将它们作为命令行参数传递:

- `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"
```

2. **使用特定的OpenAI模型进行翻译**
2. **使用特定的 OpenAI 模型进行翻译**

```bash
npx ai-markdown-translator -i input.md -o output.md -l "French" --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"
```

4. **翻译URL中的Markdown内容**
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"
```

## 许可证

[MIT许可证](LICENSE)
[MIT 许可证](LICENSE)

## Git信息
## Git 信息

- **仓库**[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.7
- **NPM 包**[ai-markdown-translator](https://www.npmjs.com/package/ai-markdown-translator)

## CI信息
## CI 信息

此项目使用GitHub Actions进行持续集成。CI工作流包括
此项目使用 GitHub Actions 进行持续集成。CI 工作流包括

- 使用ESLint对代码进行linting
- 使用 ESLint 对代码进行 linting
- 运行测试(如果适用)
- 构建项目
- 缓存依赖以加速构建

## 贡献

欢迎贡献!请随时提交Pull Request。
欢迎贡献!请随时提交 Pull Request。

## 支持

如果你遇到任何问题或有任何问题,请在这个仓库中打开一个issue
如果你遇到任何问题或有任何问题,请在这个仓库中打开一个 issue

---

这个版本将 `npx` 和独立可执行文件 (`./ai-markdown-translator`) 的使用示例合并成了一个连贯的部分。如果你想进行任何进一步的调整,请告诉我!
这个版本将 `npx` 和独立可执行文件 (`./ai-markdown-translator`) 的使用示例合并成了一个连贯的部分。如果你想进行任何进一步的调整,请告诉我!
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ npx ai-markdown-translator -u https://gitee.com/h7ml/ai-markdown-translator/raw/

## Version Information

- **Current Version**: 1.0.6
- **Current Version**: 1.0.7
- **NPM Package**: [ai-markdown-translator](https://www.npmjs.com/package/ai-markdown-translator)

## CI Information
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ai-markdown-translator",
"version": "1.0.6",
"version": "1.0.7",
"description": "CLI tool to translate Markdown files using OpenAI's language models while preserving the original formatting.",
"main": "dist/index.js",
"type": "module",
Expand Down

0 comments on commit ff29d06

Please sign in to comment.