Introduction

Documment Translator aims to easier the effort to translate Hugo documentation using VS Code.

Features

• Translate Hugo documentation using Google Translate.

Usages

1. Open File > Open Folder menu and select the Hugo project folder. You can use docsy as an example.

2. Configure languages in Hugo configuration file (hugo.toml) in your workspace.

   defaultContentLanguage: en
   defaultContentLanguageInSubdir: false
   contentDir: userguide/content/en
   
   languages:
     en:
       contentDir: userguide/content/en
       weight: 1
     zh-cn:
       contentDir: userguide/content/zh-cn
       weight: 2
   

3. Open Explorer and navitage into the folder or file you want to translate, then right click to open the context menu and select Translate. As shown in the following image, the selected file / files in the folder will be translated and the result will be saved in the folder according to the Hugo configration in step 2.

   

Extension Settings

This extension contributes the following settings:

• documentTranslator.setting.sourceLanguage: Specify the source language of these documents.
• documentTranslator.setting.tokenPath: Path to the translator token file. (Not used now.)
• documentTranslator.setting.translatorDownloadURL: Specify the URL for downloading the translator.

Known Issues and Troubleshooting

Installation Issues

1. Empty Translator Download: If the translator binary downloads as an empty file, try:

   • Checking your internet connection
   • Verifying the download URL in settings
   • If the issue persists, manually download from the release page

2. Permission Issues: On Unix-like systems (macOS, Linux), if you get permission errors:

   • The extension will automatically try to make the translator executable
   • If that fails, manually run: chmod +x path/to/translator

3. Binary Location: The translator binary should be in the following location:

   • Windows: <extension-path>/bin/translator.exe
   • macOS/Linux: <extension-path>/bin/translator

Usage Issues

1. Configuration: Make sure you have set up:

   • Hugo configuration file (hugo.toml) in your workspace

2. File Access: Ensure the extension has access to:

   • The source files you want to translate
   • The token file specified in settings
   • The workspace directory

Reporting New Issues

If you encounter any issues not listed here, please report them on our GitHub issues page with:

• A description of the problem
• Steps to reproduce (please include the file you are trying to translate)
• Your system information (OS, VS Code version)
• Relevant error messages from the Output panel (output from the Output view, select the Document Translator from the dropdown menu on the right)

Release Notes

v0.0.2

• Fix: Fixed an issue where the translator binary was not being downloaded correctly.

v0.0.1

• Initial release of Document Translator. Add support for translating Hugo documentation using Google Translate.

Enjoy!