Translate

yfm translate translates your documentation using Yandex Translator

Setup

• get your OAUTH token as described in yandex.cloud documentation

• put it inside .ya_oauth_token file inside home folder or set it with YANDEX_OAUTH_TOKEN environment variable

• get the ID of any folder that your account is granted the editor role or higher for as described in yandex.cloud documentation

• set yandexCloudTranslateFolderId inside .yfm config file to folder id you got from previous step

• set yandexCloudTranslateGlossaryPairs inside .yfm config file if you need to use glossary dictionary while translating (example below)

# glossary example

yandexCloudTranslateGlossaryPairs:
    - { sourceText: InstreamAdBreakPositionType, translatedText: InstreamAdBreakPositionType }

This will make InstreamAdBreakPositionType stay without change in the target(translated) document

Now you can use yfm cli to translate your documentation.

Flags

Usage

yfm translate --input input_folder --output output_folder --source-language ru --target-language en

This will translate your russian documentation in the input_folder into english one putting it to output_folder