Visual Studio Code extension that automatically generates multilingual README.md files using the free Google Translate API — no API key required.
- 🌍 Automatically translate
README.mdinto 10+ languages. - 🔒 Protects code blocks, inline code, and URLs from being translated.
- 💬 Adds a language switcher block (
🌐 Available in other languages: [Bahasa Indonesia](docs/lang/README-ID.md)) - 💾 Allows optional custom API key input (e.g., Google Cloud, DeepL).
- 🧠 Uses built-in Google Translate (no account needed).
- ⚙️ Simple 1-click sidebar interface.
- Minimum version: 1.85.0
- Tested on Windows, macOS, and Linux.
- Open Visual Studio Code.
- Go to the Extensions view (
Ctrl+Shift+X). - Search for
Auto Translate Readmes. - Click Install.
- Clone this repository:
git clone [https://github.com/fatonyahmadfauzi/Auto-Translate-Readmes.git](https://github.com/fatonyahmadfauzi/Auto-Translate-Readmes.git) cd Auto-Translate-Readmes npm install - Open the folder in VS Code.
- Press F5 to launch the Extension Development Host.
- In the new window, open your project containing a
README.md. - Open the sidebar → click ⚙️ Generate Multilingual READMEs.
| Command Name | Command ID | Shortcut |
|---|---|---|
| Generate Multilingual READMEs | auto-translate-readmes.run |
N/A |
Before:
# My Awesome Extension
A simple extension to help developers write better code.After (Translated):
# My Awesome Extension
> 🌐 Disponible en otros idiomas: [English](../../README.md) | [Deutsch](README-DE.md) | [Français](README-FR.md)
---
Une extension Visual Studio Code qui aide les développeurs à mieux écrire du code.The sidebar allows you to:
- 🗝️ Enter and save your own API key (optional)
- ⚙️ Click a single button to generate all translated README files
- 📁 Output stored in
docs/lang/folder
Compile TypeScript:
npm run compileLint code:
npm run lintRun tests:
npm test- Fork the repository.
- Run
npm installto install dependencies. - Make your changes.
- Compile TypeScript:
npm run compile. - Test in VS Code (press F5 → Extension Development Host).
- Submit a Pull Request.
Report issues on the GitHub Issues page.
See all notable changes for each version in the CHANGELOG.md file.
📦 You can also view release notes directly on the GitHub Releases page.
MIT License © Fatony Ahmad Fauzi