Translate Github Readme to any other Language
Translate Readme Action
README Translation
GitHub Action to translate Readme to any languageThis is a GitHub Action that automatically translate the readme in your repo to a specified language.
A submission for the DEV: GitHub Actions For Open Source! hackathon_
Setup
- Add a workflow file to your project (e.g.
.github/workflows/readme.yml):
name: Translate README
on: push: branches: - main - master jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Setup Node.js uses: actions/setup-node@v1 with: node-version: 12.x # ISO Langusge Codes: https://cloud.google.com/translate/docs/languages - name: Adding README - Chinese Simplified uses: dephraiim/translate-readme@main with: LANG: zh-CN - name: Adding README - Chinese Traditional uses: dephraiim/translate-readme@main with: LANG: zh-TW - name: Adding README - Hindi uses: dephraiim/translate-readme@main with: LANG: hi - name: Adding README - Arabic uses: dephraiim/translate-readme@main with: LANG: ar - name: Adding README - French uses: dephraiim/translate-readme@main with: LANG: fr
Configuration
Options
You can configure the action further with the following options:
LANG: The language you want to translate your readme to. The default is Simplified Chinese. (I'm a Ghanaian) The supported languages can be found below.
zh-CH) (required: false)
Supported Languages
Languages supported can be found here https://cloud.google.com/translate/docs/languages
Issues
Check here for issues related to this action.
Development
Suggestions and contributions are always welcome!
