-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- 修改 GitHub Actions 中的依赖安装命令,使用 --no-frozen-lockfile 参数 - 更新 README-zh.md 文件,增加中文标签和优化内容格式
- Loading branch information
Showing
2 changed files
with
62 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,154 +1,154 @@ | ||
# 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) | ||
[![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) | ||
![NPM Downloads](https://img.shields.io/npm/dw/ai-markdown-translator) | ||
![GitHub License](https://img.shields.io/github/license/h7ml/ai-markdown-translator) | ||
![NPM 下载量](https://img.shields.io/npm/dw/ai-markdown-translator) | ||
![GitHub 许可证](https://img.shields.io/github/license/h7ml/ai-markdown-translator) | ||
|
||
ai-markdown-translator是一个命令行工具,可以使用OpenAI的语言模型,将Markdown文件从一种语言翻译成另一种语言。它在翻译内容的同时保留了Markdown的语法。 | ||
ai-markdown-translator 是一个命令行工具,使用 OpenAI 的语言模型将 Markdown 文件从一种语言翻译成另一种语言。它在翻译内容的同时保留了 Markdown 语法。 | ||
|
||
## 特性 | ||
|
||
- 使用OpenAI的模型将Markdown文件翻译成任何支持的语言 | ||
- 在翻译过程中保留Markdown语法 | ||
- 支持通过命令行参数或环境变量进行灵活配置 | ||
- 跨平台支持(Windows、macOS、Linux) | ||
- 将 Markdown 文件翻译成 OpenAI 模型支持的任意语言 | ||
- 在翻译过程中保留 Markdown 语法 | ||
- 通过命令行参数或环境变量进行灵活配置 | ||
- 跨平台支持(Windows,macOS,Linux) | ||
|
||
## 先决条件 | ||
## 预备条件 | ||
|
||
- Node.js (v14或更高版本) | ||
- npm(通常随Node.js一起提供) | ||
- OpenAI API密钥 | ||
- Node.js(v14 或更高版本) | ||
- npm(通常与 Node.js 一起提供) | ||
- 一个 OpenAI API 密钥 | ||
|
||
## 安装 | ||
|
||
1. 克隆此仓库或下载源代码。 | ||
2. 在终端中导航至项目目录。 | ||
3. 安装依赖项: | ||
2. 在终端中导航到项目目录。 | ||
3. 安装依赖项: | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
4. 构建项目: | ||
4. 构建项目: | ||
|
||
```bash | ||
npm run build | ||
``` | ||
|
||
5. (可选)将CLI打包为一个独立可执行文件: | ||
5. (可选) 将 CLI 打包成一个独立的可执行文件: | ||
|
||
```bash | ||
npm run package | ||
``` | ||
|
||
这将在 `bin` 目录中为Windows,macOS和Linux创建可执行文件。 | ||
在 `bin` 目录中为 Windows、macOS 和 Linux 创建可执行文件。 | ||
|
||
## 脚本 | ||
|
||
- **build**: 将TypeScript文件编译为JavaScript。 | ||
- **start**: 使用Node.js运行CLI工具。 | ||
- **package**: 创建CLI的独立可执行文件。 | ||
- **lint**: 运行ESLint以检查代码质量问题。 | ||
- **lint:fix**: 自动修复lint问题。 | ||
- **format**: 使用Prettier格式化代码。 | ||
- **format:check**: 检查代码格式化情况,但不做修改。 | ||
- **build**:将 TypeScript 文件编译为 JavaScript。 | ||
- **start**:使用 Node.js 运行 CLI 工具。 | ||
- **package**:为 CLI 创建独立的可执行文件。 | ||
- **lint**:运行 ESLint 检查代码质量问题。 | ||
- **lint:fix**:自动修复 linting 问题。 | ||
- **format**:使用 Prettier 格式化代码。 | ||
- **format:check**:检查代码格式,不作更改。 | ||
|
||
## 使用方法 | ||
## 用法 | ||
|
||
您可以使用Node.js,`npx`,或作为一个独立的可执行文件(如果您已经打包过它)来运行CLI工具。 | ||
可以使用 Node.js,`npx`,或作为一个独立的可执行程序运行 CLI 工具(如果你已经打包了它)。 | ||
|
||
### 使用Node.js | ||
### 使用 Node.js | ||
|
||
```bash | ||
node dist/index.js --input <input-file> --output <output-file> --language <target-language> [options] | ||
node dist/index.js --input <输入文件> --output <输出文件> --language <目标语言> [选项] | ||
``` | ||
|
||
### 使用npx | ||
### 使用 npx | ||
|
||
```bash | ||
npx ai-markdown-translator -i <input-file> -o <output-file> -l <target-language> [options] | ||
npx ai-markdown-translator -i <输入文件> -o <输出文件> -l <目标语言> [选项] | ||
``` | ||
|
||
### 使用独立的可执行文件 | ||
### 使用独立的可执行程序 | ||
|
||
```bash | ||
./ai-markdown-translator --input <input-file> --output <output-file> --language <target-language> [options] | ||
./ai-markdown-translator --input <输入文件> --output <输出文件> --language <目标语言> [选项] | ||
``` | ||
|
||
### 选项 | ||
|
||
- `--input`, `-i`: 输入Markdown文件(必须) | ||
- `--output`, `-o`: 输出Markdown文件(必须) | ||
- `--language`, `-l`: 目标翻译语言(必须) | ||
- `--openai-url`: OpenAI API URL(默认: 使用OPENAI_URL环境变量) | ||
- `--api-key`: OpenAI API Key(默认: 使用API_KEY环境变量) | ||
- `--model`: 使用的OpenAI Model(默认: 使用MODEL环境变量或'gpt-3.5-turbo') | ||
- `--help`, `-h`: 显示帮助 | ||
- `--input`, `-i`:输入 Markdown 文件(必需) | ||
- `--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`:显示帮助 | ||
|
||
## 环境变量 | ||
|
||
您可以设置以下环境变量,而不是将它们作为命令行参数传递: | ||
可以设置以下环境变量,而无需将它们作为命令行参数传递: | ||
|
||
- `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 | ||
./ai-markdown-translator --input english.md --output spanish.md --language "Spanish" | ||
``` | ||
|
||
2. 使用特定的OpenAI模型进行翻译: | ||
2. 使用指定的 OpenAI 模型进行翻译: | ||
|
||
```bash | ||
./ai-markdown-translator --input input.md --output output.md --language "French" --model "gpt-4" | ||
``` | ||
|
||
3. 使用自定义的OpenAI URL和API密码进行翻译: | ||
3. 使用自定义的 OpenAI URL 和 API 密钥进行翻译: | ||
|
||
```bash | ||
./ai-markdown-translator --input input.md --output output.md --language "German" --openai-url "https://api.302.ai/v1/chat/completions" --api-key "sk-302-api-key" | ||
``` | ||
|
||
4. 使用`npx`来翻译一个Markdown文件: | ||
4. 使用 `npx` 翻译 Markdown 文件: | ||
|
||
```bash | ||
npx ai-markdown-translator -i input.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) | ||
- **仓库**:[h7ml/ai-markdown-translator](https://github.com/h7ml/ai-markdown-translator) | ||
- **问题**:[报告问题](https://github.com/h7ml/ai-markdown-translator/issues) | ||
|
||
## 版本信息 | ||
|
||
- **当前版本**: 1.0.1 | ||
- **NPM包**: [ai-markdown-translator](https://www.npmjs.com/package/ai-markdown-translator) | ||
- **当前版本**:1.0.1 | ||
- **NPM 包**:[ai-markdown-translator](https://www.npmjs.com/package/ai-markdown-translator) | ||
|
||
## CI信息 | ||
## CI 信息 | ||
|
||
此项目使用GitHub Action进行持续集成。CI工作流包括: | ||
此项目使用 GitHub Actions 进行持续集成。CI 工作流包括: | ||
|
||
- 使用ESLint对代码进行lint | ||
- 使用 ESLint 检查代码 | ||
- 运行测试(如果适用) | ||
- 构建项目 | ||
- 缓存依赖项以加速构建 | ||
- 缓存依赖项以加快构建速度 | ||
|
||
## 贡献 | ||
|
||
欢迎大家提交Pull Request对本项目进行贡献! | ||
欢迎贡献!请随时提交拉取请求。 | ||
|
||
## 技术支持 | ||
## 支持 | ||
|
||
如果您遇到任何问题或有任何疑问,请在本仓库开一共新的问题。 | ||
如果遇到任何问题或有任何问题,请在此库开一个问题。 |