DEV Community

loading...
Cover image for Translate Markdown(Readme.md) to Any Language.

Translate Markdown(Readme.md) to Any Language.

Ephraim Atta-Duncan
🦄 | I love unicorns
・2 min read

My Workflow

I have seen for a while that contributors of many open source projects require other developers who are fluent in certain languages to translate thier documentation to thier language, and this being a good thing to do, it sometimes waste time and also some languages are not translated. Translate Readme is a Github Action that translate your Readme(for now) to other languages supported by Google Translate. It is free and open-source

Submission Category:

This is definetly what a Maintainer Must-Have.
Maintainer Must-Haves

Yaml File or Link to Code

GitHub logo dephraiim / translate-readme

Translate Github Readme to any other Language


Create a workflow file with the code below to use the action in your repository
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
      - name: Adding License
        uses: dephraiim/translate-readme@v1
        with:
          LANG: zh-CN # Simplified Chinese
          # Change the language to your specified language.

Additional Resources / Info

Check https://github.com/dephraiim/translate-readme/issues/1 for a minor issue I found during testing. This action supports all markdown files but I have made it Readme.md specific for the mean time.

I tested it on a fork of 33-js-concepts. Find it here

Discussion (2)

Collapse
Sloan, the sloth mascot
Comment deleted
Collapse
dephraiim profile image
Ephraim Atta-Duncan Author

Can I see your test.yml file?