Skip to content

fatonyahmadfauzi/MultiDoc-Translator

Repository files navigation

🌍 Auto Translate Readmes

VS Code Version License: MIT Build Status Repo Size Last Commit Installs Downloads Rating


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: [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.

✅ Supported VS Code Versions

  • Minimum version: 1.85.0
  • Tested on Windows, macOS, and Linux.

🧩 Installation

From Marketplace (Recommended)

  1. Open Visual Studio Code.
  2. Go to the Extensions view (Ctrl+Shift+X).
  3. Search for Auto Translate Readmes.
  4. Click Install.

For Development (from Source Code)

  1. 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
  2. Open the folder in VS Code.
  3. Press F5 to launch the Extension Development Host.
  4. In the new window, open your project containing a README.md.
  5. 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](../../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.

🧠 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

  1. Fork the repository.
  2. Run npm install to install dependencies.
  3. Make your changes.
  4. Compile TypeScript: npm run compile.
  5. Test in VS Code (press F5 → Extension Development Host).
  6. Submit a Pull Request.

🐞 Bugs & Issues

Report issues on the GitHub Issues page.


🧾 Changelog

See all notable changes for each version in the CHANGELOG.md file.

📦 You can also view release notes directly on the GitHub Releases page.


🧾 License

MIT License © Fatony Ahmad Fauzi

About

Automatically translate your README.md into 10+ languages directly inside VS Code. Intelligently protects code blocks and URLs from translation. Powered by the free Google Translate API.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors