Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrf0rtuna4/git-markdown-autotranslator
🗯 Automatic translation of your READMEs, simply fast and convenient
https://github.com/mrf0rtuna4/git-markdown-autotranslator
github-actions github-readme readme translation
Last synced: about 11 hours ago
JSON representation
🗯 Automatic translation of your READMEs, simply fast and convenient
- Host: GitHub
- URL: https://github.com/mrf0rtuna4/git-markdown-autotranslator
- Owner: mrf0rtuna4
- License: mit
- Created: 2024-05-02T12:24:56.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-09-26T19:17:07.000Z (about 1 month ago)
- Last Synced: 2024-11-07T04:16:39.893Z (about 11 hours ago)
- Topics: github-actions, github-readme, readme, translation
- Language: Python
- Homepage:
- Size: 113 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Markdown Files AutoTranslator
> [!WARNING]
> We only use TRANSLATION DeepL
>
> This may affect the quality of the translation. It may also cause the system to MIS-identify your file data.
This GitHub Action automatically generates and pushes localized versions of your *.md files based on the supported languages.
## Usage
To use this action, create a workflow file (e.g., `.github/workflows/translate.yml`) in your repository with the following content:
```yml
name: Generate Localized File # The name of your action
on:
workflow_dispatch: # Manual start
push: # Run when committing to a branch
branches:
- master # Set the name of your branch if required
paths: # Start translating only if file changed in current push
- 'README.md'
jobs:
translate: # Task name
runs-on: ubuntu-latest # Running on an Ubuntu image
steps:
- name: Checkout code # Step: code check
uses: actions/checkout@v2 # Using an action to test the code
- name: Run translation # Step: start the translation
uses: mrf0rtuna4/[email protected] # Using an action to translate
env:
FILES: 'README.md' # The *.md files to be translate
LANGS: 'english,italian,dutch,spanish' # List of languages to be translated
- name: Push to GitHub # Step: Submit changes to GitHub
uses: crazy-max/[email protected] # Using an action to publish to GitHub Pages
with:
target_branch: translations # The branch to which the changes will be sent
build_dir: 'dist' # The directory with the collected files
env:
GITHUB_TOKEN: ${{ secrets.GTK }} # Transferring a GitHub access token
```
Replace `LANGS` with a comma-separated list of languages you want to generate.
Available languages for translation (complete references)
```yaml
'afrikaans', 'albanian', 'amharic', 'arabic', 'armenian', 'assamese', 'aymara', 'azerbaijani', 'bambara', 'basque',
'belarusian', 'bengali', 'bhojpuri', 'bosnian', 'bulgarian', 'catalan', 'cebuano', 'chichewa', 'chinese (simplified)',
'chinese (traditional)', 'corsican', 'croatian', 'czech', 'danish', 'dhivehi', 'dogri', 'dutch', 'english', 'esperanto',
'estonian', 'ewe', 'filipino', 'finnish', 'french', 'frisian', 'galician', 'georgian', 'german', 'greek', 'guarani',
'gujarati', 'haitian creole', 'hausa', 'hawaiian', 'hebrew', 'hindi', 'hmong', 'hungarian', 'icelandic', 'igbo', 'ilocano',
'indonesian', 'irish', 'italian', 'japanese', 'javanese', 'kannada', 'kazakh', 'khmer', 'kinyarwanda', 'konkani', 'korean',
'krio', 'kurdish (kurmanji)', 'kurdish (sorani)', 'kyrgyz', 'lao', 'latin', 'latvian', 'lingala', 'lithuanian', 'luganda',
'luxembourgish', 'macedonian', 'maithili', 'malagasy', 'malay', 'malayalam', 'maltese', 'maori', 'marathi', 'meiteilon (manipuri)',
'mizo', 'mongolian', 'myanmar', 'nepali', 'norwegian', 'odia (oriya)', 'oromo', 'pashto', 'persian', 'polish', 'portuguese',
'punjabi', 'quechua', 'romanian', 'russian', 'samoan', 'sanskrit', 'scots gaelic', 'sepedi', 'serbian', 'sesotho', 'shona',
'sindhi', 'sinhala', 'slovak', 'slovenian', 'somali', 'spanish', 'sundanese', 'swahili', 'swedish', 'tajik', 'tamil', 'tatar',
'telugu', 'thai', 'tigrinya', 'tsonga', 'turkish', 'turkmen', 'twi', 'ukrainian', 'urdu', 'uyghur', 'uzbek', 'vietnamese',
'welsh', 'xhosa', 'yiddish', 'yoruba', 'zulu'
```
Available languages for translation (short addresses)
```yaml
'af', 'sq', 'am', 'ar', 'hy', 'as', 'ay', 'az', 'bm', 'eu', 'be', 'bn', 'bho', 'bs', 'bg', 'ca', 'ceb', 'ny',
'zh-CN', 'zh-TW', 'co', 'hr', 'cs', 'da', 'dv', 'doi', 'nl', 'en', 'eo', 'et', 'ee', 'tl', 'fi', 'fr', 'fy', 'gl',
'ka', 'de', 'el', 'gn', 'gu', 'ht', 'ha', 'haw', 'iw', 'hi', 'hmn', 'hu', 'is', 'ig', 'ilo', 'id', 'ga', 'it', 'ja',
'jw', 'kn', 'kk', 'km', 'rw', 'gom', 'ko', 'kri', 'ku', 'ckb', 'ky', 'lo', 'la', 'lv', 'ln', 'lt', 'lg', 'lb', 'mk',
'mai', 'mg', 'ms', 'ml', 'mt', 'mi', 'mr', 'mni-Mtei', 'lus', 'mn', 'my', 'ne', 'no', 'or', 'om', 'ps', 'fa', 'pl',
'pt', 'pa', 'qu', 'ro', 'ru', 'sm', 'sa', 'gd', 'nso', 'sr', 'st', 'sn', 'sd', 'si', 'sk', 'sl', 'so', 'es', 'su',
'sw', 'sv', 'tg', 'ta', 'tt', 'te', 'th', 'ti', 'ts', 'tr', 'tk', 'ak', 'uk', 'ur', 'ug', 'uz', 'vi', 'cy', 'xh', 'yi', 'yo', 'zu'
```
## Configuration
You can configure this action using the following inputs:
- `FILES`: A comma-separated list of files to translate.
- `LANGS`: A comma-separated list of languages to generate.
## Example
For example, if you want to generate files for Serbian, Italian, and English languages, your configuration would look like this:
```yml
- name: Run translation
env:
FILES: 'README.md'
LANGS: 'italian,english'
```
And you can view, how to work action by clicking this widgets:
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.