实战范例：翻译 README

这份范例带你一步步将 Markdown README 翻译成其他语言，所有结构元素都保持完整。

基本用法

yaku --to zh-CN -f README.md -o README.zh-CN.md

yaku 检测到 .md 扩展名后，会应用格式感知翻译：标题、代码块、链接、图片和 front matter 保持不动，只翻译文字内容。

逐步教学

1. 创建术语表（可选但建议）

在项目根目录创建 .yaku-glossary.yaml，锁定关键用词：

zh-CN:
  MyProject: ~           # 保留项目名称
  GitHub: ~
  npm: ~
  MIT License: MIT 许可证

2. 翻译

yaku --to zh-CN -f README.md -o README.zh-CN.md

3. 检查输出

确认以下几点：

• 标题层级是否正确？
• 代码块是否未被修改？
• 链接网址和图片路径是否完整？
• 术语表中的用词是否翻译正确？

4. 翻译成其他语言

yaku --to ja -f README.md -o README.ja.md
yaku --to ko -f README.md -o README.ko.md

加上上下文提升质量

如果你的 README 涵盖特定领域，加上上下文说明：

yaku --to zh-CN \
  --context "CLI developer tool documentation" \
  -f README.md -o README.zh-CN.md

用脚本自动化

将 README 翻译成多种语言：

#!/bin/bash
LANGUAGES=("zh-CN" "ja" "ko" "fr" "de")

for lang in "${LANGUAGES[@]}"; do
  yaku --to "$lang" -f README.md -o "README.${lang}.md"
  echo "已翻译成 $lang"
done

小技巧

• 务必检查输出。 LLM 翻译质量不错但并非完美。请确认品牌名称、技术用语和惯用语的正确性。
• 使用术语表确保一致性。 如果你在更新 README 后重新翻译，术语表能确保每次使用相同的翻译。
• 从源文件翻译。 一律从英文（或源语言）的 README 翻译，而不是从另一个翻译版本——避免错误层层累积。