Visual Studio Code extension that automatically generates multilingual README.md files using the free Google Translate API — no API key required.
✨ Features
🌍 Automatically translate README.md into 10+ languages.
🔒 Protects code blocks, inline code, and URLs from being translated.
💬 Adds a language switcher block (🌐 Available in other languages:) automatically.
💾 Allows optional custom API key input (e.g., Google Cloud, DeepL).
🧠 Uses built-in Google Translate (no account needed).
⚙️ Simple 1-click sidebar interface.
✅ Supported VS Code Versions
Minimum version: 1.85.0
Tested on Windows, macOS, and Linux.
🧩 Installation
From Marketplace (Recommended)
Open Visual Studio Code.
Go to the Extensions view (Ctrl+Shift+X).
Search for Auto Translate Readmes.
Click Install.
For Development (from Source Code)
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.
⌨️ Commands & Shortcuts
Command Name
Command ID
Shortcut
Generate Multilingual READMEs
auto-translate-readmes.run
N/A
🧠 Example
Before:
# My Awesome Extension
A simple extension to help developers write better code.
After (Translated):
# My Awesome Extension
> 🌐 Disponible en otros idiomas: [English](https://github.com/fatonyahmadfauzi/Auto-Translate-Readmes/blob/HEAD/../../README.md) | [Deutsch](https://github.com/fatonyahmadfauzi/Auto-Translate-Readmes/blob/HEAD/README-DE.md) | [Français](https://github.com/fatonyahmadfauzi/Auto-Translate-Readmes/blob/HEAD/README-FR.md)
---
Une extension Visual Studio Code qui aide les développeurs à mieux écrire du code.
🧠 Sidebar Interface
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
🛠️ Development
Compile TypeScript:
npm run compile
Lint code:
npm run lint
Run tests:
npm test
🧑💻 Contributing
Fork the repository.
Run npm install to install dependencies.
Make your changes.
Compile TypeScript: npm run compile.
Test in VS Code (press F5 → Extension Development Host).
