DEV Community

Cover image for Translate Markdown( to Any Language.
Ephraim Atta-Duncan
Ephraim Atta-Duncan

Posted on

Translate Markdown( to Any Language.

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

      - main
      - master

    runs-on: ubuntu-latest
      - uses: actions/checkout@v2
      - name: Setup Node.js
        uses: actions/setup-node@v1
          node-version: 12.x
      - name: Adding License
        uses: dephraiim/translate-readme@v1
          LANG: zh-CN # Simplified Chinese
          # Change the language to your specified language.
Enter fullscreen mode Exit fullscreen mode

Additional Resources / Info

Check for a minor issue I found during testing. This action supports all markdown files but I have made it specific for the mean time.

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

Top comments (2)

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

Can I see your test.yml file?