Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 2.18 KB

README_CN.md

File metadata and controls

54 lines (39 loc) · 2.18 KB

Markdown-i18n

英文 | 中文 | 繁体中文 ｜ 日本語 | 한국어

每次更新项目文档都要同时维护两份或者多种语言的文档实在过于痛苦了，于是我写了个脚本来帮我更新多语言 README 文档。我希望可以用自己的母语写文档，并能同时翻译到任何语言，并且保持文档格式不变。Markdown-i18n 解决了这些痛点。

特性

  • 支持增量翻译。仅翻译修改的部分，未修改的部分不会重复翻译。大幅提高翻译效率。大幅减少 token 消耗。
  • 给任何 markdown 文档添加 i18n 支持，支持从任何语言翻译到任何语言。
  • 完美遵循原文件的格式。
  • 同时保证翻译地道、准确。
  • 高效翻译。

使用指南

  1. 安装依赖
pip install -r requirements.txt
  1. 开始翻译

方法一：创建一个新的 python 文件

import os
from translate_md import translate
from parse_markdown import check_markdown_parse

api_key = os.getenv("API")       # OpenAI API key
api_url = os.getenv("API_URL")   # OpenAI API URL
engine = "gpt-4o"                # 语言模型

input_file_path = "README-zh.md" # 原文件路径
output_file_path = "README.md"   # 输出文件路径
language = "English"             # 目标语言
check_markdown_parse(input_file_path) # 检查 markdown 文件是否解析正确，解析正确就可以翻译，如果报错需要联系作者修复。这一步不是必要的，只是为了保证翻译的格式准确性。
translate(input_file_path, output_file_path, language, api_key, api_url, engine) # 翻译原markdown文件到目标语言并保存到输出文件

方法二：使用仓库里现成的脚本

直接修改 translate_md.py 文件中的配置，然后运行脚本即可。

input_file_path = "README_CN.md" # 原文件路径
output_file_path = "README.md"   # 输出文件路径
language = "English"             # 目标语言
api_key = os.getenv("API")       # OpenAI API key
api_url = os.getenv("API_URL")   # OpenAI API URL 默认是 "https://api.openai.com/v1/chat/completions"
engine = "gpt-4o"                # 语言模型