https://github.com/3ru/gpt-translate
💬Translate Files into Any Languages with AI
https://github.com/3ru/gpt-translate
actions gitbook github-actions i18n language openai translation
Last synced: about 1 year ago
JSON representation
💬Translate Files into Any Languages with AI
- Host: GitHub
- URL: https://github.com/3ru/gpt-translate
- Owner: 3ru
- License: mit
- Created: 2023-03-29T13:27:06.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-04-10T07:38:37.000Z (about 1 year ago)
- Last Synced: 2025-05-12T10:10:40.387Z (about 1 year ago)
- Topics: actions, gitbook, github-actions, i18n, language, openai, translation
- Language: MDX
- Homepage: https://g-t.vercel.app
- Size: 4.07 MB
- Stars: 223
- Watchers: 0
- Forks: 37
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 🌎 Markdown Translation BOT
[](https://codeclimate.com/github/3ru/gpt-translate/maintainability)
[](https://github.com/3ru/gpt-translate/actions/workflows/gpt-translate.yml)
[](https://openai.com/)
[](https://azure.microsoft.com/en-us/products/ai-services/openai-service)
[](https://www.anthropic.com/)
[](https://docs.perplexity.ai/)
[](https://ai.google/discover/generativeai/)
[](https://groq.com/)
[](https://fireworks.ai/)
[](https://mistral.ai/)
[](https://cohere.com/)
[English](/README.md) |
[简体中文](/README/README.zh-CN.md) |
[繁體中文](/README/README.zh-TW.md) |
[Español](/README/README.es.md) |
[हिंदी, हिन्दी](/README/README.hi.md) |
[한국어](/README/README.ko.md) |
[日本語](/README/README.ja.md)
This GitHub action translates your markdown files into multiple languages using multiple AI models.
> [!TIP]
> Now Available: **AI Models from Multiple Providers✨** \
> We've expanded beyond OpenAI to support various AI model providers. \
> For a comprehensive [list of supported providers](https://g-t.vercel.app/docs/references/supported-model-provider) and detailed information, please refer to our [release notes](https://github.com/3ru/gpt-translate/releases/tag/v1.2.0-beta).
🧐 Current Status
- The action supports translating **markdown(`.md`), markdown-jsx(`.mdx`), json(`.json`) files only**.
- The command can be executed exclusively by individuals with **write permissions to the repository**.
These limitations prevent API abuse by non-trusted parties.
## 🔧 Setup
### Repository Settings
#### 1. Settings > Actions > General
- Enable `Read and write permissions`
- Enable `Allow GitHub Actions to create and approve pull requests`
#### 2. Settings > Secrets and variables > Actions
- Set [your API key](https://platform.openai.com/account/api-keys)(`OPENAI_API_KEY`) to secrets
### GitHub Actions Workflow Settings
#### Required
- Provide the OPENAI_API_KEY as apiKey.
- Set `on` to trigger when a comment is created (`types: [ created ]`).
- Checkout in advance(`actions/checkout@v3`).
#### Recommended (To minimize unnecessary run time)
- Configure if to run only when `/gpt-translate` or `/gt` is present in the comment.
👇 Here is a minimal workflow example:
```yaml
# .github/workflows/gpt-translate.yml
name: GPT Translate
on:
issue_comment:
types: [ created ]
jobs:
gpt_translate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run GPT Translate
if: |
contains(github.event.comment.body, '/gpt-translate') ||
contains(github.event.comment.body, '/gt')
uses: 3ru/gpt-translate@master
with:
apikey: ${{ secrets.OPENAI_API_KEY }}
```
## 💡 Usage
```
/gpt-translate [input filepath] [output filepath] [target language]
```
You can use /gt as a shorthand for /gpt-translate.
1.Create a comment with `/gpt-translate` or `/gt` in an issue or pull request.
2.【On issue】Translated files will be created as a **pull request**.
2.【On pull request】Translated files will be **added to the pull request with new commit**.
In other words, if you keep commenting on an issue, new PRs will continuously be created.
If you keep commenting on a PR, new commits will continuously be added to that PR.
## 📝 Example
```
/gpt-translate README.md zh-TW/README.md traditional-chinese
```
Translate `README.md` into traditional Chinese and place it under the `zh-TW` directory.
### Multiple file support
You can translate multiple files at once by specifying a wildcard in the input file path.
Here is a sample
```
/gpt-translate *.md *.ja.md Japanese
```
If `A.md` and `B.md` are in the root directory, the output will be `A.ja.md` and `B.ja.md`. The file names are inherited from the input files.
I am considering outputting the file with an arbitrary file name, but if you have a smart idea, please suggest it through the issue!
For more information, please refer to the [website](https://g-t.vercel.app/docs/references/path-builder)
## 🌐 Supported Languages
**Any language** interpreted by GPT-4 or GPT-3.5
## 🏘️ Community
- [Discussions](https://github.com/3ru/gpt-translate/discussions)
- If you have any questions, please feel free to ask in the GitHub Discussions :)
- [Issues](https://github.com/3ru/gpt-translate/issues)
- Please submit bugs and new feature suggestions to GitHub Issues
## 📃 License
MIT License