{"id":18622413,"url":"https://github.com/mrf0rtuna4/git-markdown-autotranslator","last_synced_at":"2025-04-11T03:31:17.373Z","repository":{"id":237676438,"uuid":"795017409","full_name":"mrf0rtuna4/Git-Markdown-AutoTranslator","owner":"mrf0rtuna4","description":"🗯 Automatic translation of your READMEs, simply fast and convenient","archived":false,"fork":false,"pushed_at":"2025-01-16T10:38:20.000Z","size":118,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T08:42:30.220Z","etag":null,"topics":["github-actions","github-readme","readme","translation"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mrf0rtuna4.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-02T12:24:56.000Z","updated_at":"2025-02-20T14:23:21.000Z","dependencies_parsed_at":"2024-05-03T00:29:08.865Z","dependency_job_id":"93047b7d-77fe-4ad8-b27a-3745a043ac65","html_url":"https://github.com/mrf0rtuna4/Git-Markdown-AutoTranslator","commit_stats":null,"previous_names":["mrf0rtuna4/github-readme-autotranslator","mrf0rtuna4/git-markdown-autotranslator"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrf0rtuna4%2FGit-Markdown-AutoTranslator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrf0rtuna4%2FGit-Markdown-AutoTranslator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrf0rtuna4%2FGit-Markdown-AutoTranslator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrf0rtuna4%2FGit-Markdown-AutoTranslator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mrf0rtuna4","download_url":"https://codeload.github.com/mrf0rtuna4/Git-Markdown-AutoTranslator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248335431,"owners_count":21086589,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions","github-readme","readme","translation"],"created_at":"2024-11-07T04:16:45.031Z","updated_at":"2025-04-11T03:31:17.355Z","avatar_url":"https://github.com/mrf0rtuna4.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Markdown Files AutoTranslator\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/v/release/mrf0rtuna4/Git-Markdown-AutoTranslator\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/mrf0rtuna4/Git-Markdown-AutoTranslator/example.yml\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/mrf0rtuna4/Git-Markdown-AutoTranslator/development.yml\"\u003e\n\u003c/div\u003e\n\n\n\u003e [!WARNING]\n\u003e We only use TRANSLATION DeepL\n\u003e\n\u003e This may affect the quality of the translation. It may also cause the system to MIS-identify your file data.\n\nThis GitHub Action automatically generates and pushes localized versions of your *.md files based on the supported languages.\n\n## Usage\n\nTo use this action, create a workflow file (e.g., `.github/workflows/translate.yml`) in your repository with the following content:\n\n```yml\nname: Generate Localized File  # The name of your action\n\non:\n  workflow_dispatch:  # Manual start\n  push:  # Run when committing to a branch\n    branches:\n    - master # Set the name of your branch if required\n    paths: # Start translating only if file changed in current push\n    - 'README.md'\n\njobs:\n  translate:  # Task name\n    runs-on: ubuntu-latest  # Running on an Ubuntu image\n    steps:\n      - name: Checkout code  # Step: code check\n        uses: actions/checkout@v2  # Using an action to test the code\n\n      - name: Run translation  # Step: start the translation\n        uses: mrf0rtuna4/Git-Markdown-AutoTranslator@v2.1.0  # Using an action to translate\n        env:\n          FILES: 'README.md' # The *.md files to be translate\n          LANGS: 'english,italian,dutch,spanish' # List of languages to be translated\n\n      - name: Push to GitHub  # Step: Submit changes to GitHub\n        uses: crazy-max/ghaction-github-pages@v3.1.0  # Using an action to publish to GitHub Pages\n        with:\n          target_branch: translations  # The branch to which the changes will be sent\n          build_dir: 'dist'  # The directory with the collected files\n        env:\n          GITHUB_TOKEN: ${{ secrets.GTK }}  # Transferring a GitHub access token\n```\n\nReplace `LANGS` with a comma-separated list of languages you want to generate.\n\u003cdetails\u003e\n\u003csummary\u003e\n  Available languages for translation (complete references)\n\u003c/summary\u003e\n\n```yaml\n    'afrikaans', 'albanian', 'amharic', 'arabic', 'armenian', 'assamese', 'aymara', 'azerbaijani', 'bambara', 'basque', \n    'belarusian', 'bengali', 'bhojpuri', 'bosnian', 'bulgarian', 'catalan', 'cebuano', 'chichewa', 'chinese (simplified)', \n    'chinese (traditional)', 'corsican', 'croatian', 'czech', 'danish', 'dhivehi', 'dogri', 'dutch', 'english', 'esperanto', \n    'estonian', 'ewe', 'filipino', 'finnish', 'french', 'frisian', 'galician', 'georgian', 'german', 'greek', 'guarani', \n    'gujarati', 'haitian creole', 'hausa', 'hawaiian', 'hebrew', 'hindi', 'hmong', 'hungarian', 'icelandic', 'igbo', 'ilocano', \n    'indonesian', 'irish', 'italian', 'japanese', 'javanese', 'kannada', 'kazakh', 'khmer', 'kinyarwanda', 'konkani', 'korean', \n    'krio', 'kurdish (kurmanji)', 'kurdish (sorani)', 'kyrgyz', 'lao', 'latin', 'latvian', 'lingala', 'lithuanian', 'luganda', \n    'luxembourgish', 'macedonian', 'maithili', 'malagasy', 'malay', 'malayalam', 'maltese', 'maori', 'marathi', 'meiteilon (manipuri)',\n    'mizo', 'mongolian', 'myanmar', 'nepali', 'norwegian', 'odia (oriya)', 'oromo', 'pashto', 'persian', 'polish', 'portuguese', \n    'punjabi', 'quechua', 'romanian', 'russian', 'samoan', 'sanskrit', 'scots gaelic', 'sepedi', 'serbian', 'sesotho', 'shona', \n    'sindhi', 'sinhala', 'slovak', 'slovenian', 'somali', 'spanish', 'sundanese', 'swahili', 'swedish', 'tajik', 'tamil', 'tatar',\n    'telugu', 'thai', 'tigrinya', 'tsonga', 'turkish', 'turkmen', 'twi', 'ukrainian', 'urdu', 'uyghur', 'uzbek', 'vietnamese', \n    'welsh', 'xhosa', 'yiddish', 'yoruba', 'zulu'\n```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\n  Available languages for translation (short addresses)\n\u003c/summary\u003e\n\n```yaml\n'af', 'sq', 'am', 'ar', 'hy', 'as', 'ay', 'az', 'bm', 'eu', 'be', 'bn', 'bho', 'bs', 'bg', 'ca', 'ceb', 'ny',\n'zh-CN', 'zh-TW', 'co', 'hr', 'cs', 'da', 'dv', 'doi', 'nl', 'en', 'eo', 'et', 'ee', 'tl', 'fi', 'fr', 'fy', 'gl',\n'ka', 'de', 'el', 'gn', 'gu', 'ht', 'ha', 'haw', 'iw', 'hi', 'hmn', 'hu', 'is', 'ig', 'ilo', 'id', 'ga', 'it', 'ja',\n'jw', 'kn', 'kk', 'km', 'rw', 'gom', 'ko', 'kri', 'ku', 'ckb', 'ky', 'lo', 'la', 'lv', 'ln', 'lt', 'lg', 'lb', 'mk',\n'mai', 'mg', 'ms', 'ml', 'mt', 'mi', 'mr', 'mni-Mtei', 'lus', 'mn', 'my', 'ne', 'no', 'or', 'om', 'ps', 'fa', 'pl',\n'pt', 'pa', 'qu', 'ro', 'ru', 'sm', 'sa', 'gd', 'nso', 'sr', 'st', 'sn', 'sd', 'si', 'sk', 'sl', 'so', 'es', 'su',\n'sw', 'sv', 'tg', 'ta', 'tt', 'te', 'th', 'ti', 'ts', 'tr', 'tk', 'ak', 'uk', 'ur', 'ug', 'uz', 'vi', 'cy', 'xh', 'yi', 'yo', 'zu'\n```\n\n\u003c/details\u003e\n\n\n## Configuration\n\nYou can configure this action using the following inputs:\n\n- `FILES`: A comma-separated list of files to translate.\n- `LANGS`: A comma-separated list of languages to generate.\n- `DEBUG`: Set to `True` to enable detailed logging of the translation process. This is useful for troubleshooting but may generate verbose output.\n- `MAX_LINELENGTH_`: Specifies the maximum allowed line length for translation. **Use with caution!** Setting this value too low can cause errors or incomplete translations.\n\n\u003e [!WARNING] \n\u003e Avoid using `MAX_LINELENGTH_` without fully understanding its implications. \n\u003e Improper configuration (e.g., a very low value) may lead to unexpected behavior or translation failures.\n\n\n## Example\n\nFor example, if you want to generate files for Serbian, Italian, and English languages, your configuration would look like this:\n\n```yml\n      - name: Run translation\n        env:\n          FILES: 'README.md' \n          LANGS: 'italian,english'\n```\n\nAnd you can view, how to work action by clicking this widgets:\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/mrf0rtuna4/Git-Markdown-AutoTranslator/blob/translations/ru_README.md\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/Язык-Руский-blue\" alt=\"Руский\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/mrf0rtuna4/Git-Markdown-AutoTranslator/blob/translations/ja_README.md\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/言語-日本語-blue\" alt=\"日本語\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/mrf0rtuna4/Git-Markdown-AutoTranslator/blob/translations/it_README.md\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/Lingua-Italiano-blue\" alt=\"Italiano\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/mrf0rtuna4/Git-Markdown-AutoTranslator/blob/translations/uk_README.md\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/Мова-Українська-blue\" alt=\"Українська\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/mrf0rtuna4/Git-Markdown-AutoTranslator/blob/translations/ar_README.md\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/لغة-العربية-blue\" alt=\"العربية\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrf0rtuna4%2Fgit-markdown-autotranslator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrf0rtuna4%2Fgit-markdown-autotranslator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrf0rtuna4%2Fgit-markdown-autotranslator/lists"}