Translate Readme FreeBeta
ByCrowdinVerified Author

A GitHub Action to automate the translation of your README.md files

Try Crowdin

Translate README: Automate the translation of README.md files

Copy link

What does this action do?

Copy link
  • Upload your README.md file to Crowdin
  • Download the translations from Crowdin to the specified place
  • Manage the languages switcher in your README.md file

Usage

Copy link

Set up a workflow in .github/workflows/translate-readme.yml (or add a job to your existing workflows).

Read the Configuring a workflow article for more details on how to create and set up custom workflows.

# .github/workflows/translate-readme.yml
name: Translate Readme

on:
  # When you push to the `main` branch
  push:
    branches: [ main ]
  # And optionally, once every 12 hours
  schedule:
    - cron: '0 */12 * * *' # https://crontab.guru/#0_*/12_*_*_*
  # To manually run this workflow
  workflow_dispatch:

jobs:
  translate-readme:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout
      uses: actions/checkout@v3

    - name: Translate Readme
      uses: crowdin/translate-readme@v0.1.0
      env:
        CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
        CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
        # Optional. Only for Crowdin Enterprise
        CROWDIN_ORGANIZATION: ${{ secrets.CROWDIN_ORGANIZATION }}

For more examples, see the Marketplace Page.

Crowdin is a platform that helps you manage and translate content into different languages. Integrate Crowdin with your repo, CMS, or other systems. Source content is always up to date for your translators, and translated content is returned automatically.

Learn More
Categories
Development
Works with
  • Crowdin Enterprise
  • crowdin.com
Details

Released on Jul 24, 2023

Updated on Jul 30, 2024

Published by Crowdin

Identifier:translate-readme