Skip to content

GuanceCloud/mkdocs-auto-translation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MkDocs Translator

MkDocs Translator 是一个自动化工具,用于将 MkDocs 文档库从一种语言翻译为另一种语言。它使用 Dify AI API 进行翻译,并保持文档的目录结构和 Markdown 格式。

特性

  • 使用 Dify AI API 进行高质量的文档翻译
  • 保持原始文档的目录结构和 Markdown 格式
  • 支持增量翻译,避免重复处理未更改的文件
  • 自动复制非翻译文件(如图片、CSS等)到目标目录
  • 提供详细的翻译进度和结果报告
  • 支持流式翻译响应,实时显示翻译进度

安装

  1. 克隆仓库:
git clone https://github.com/GuanceCloud/mkdocs-translator.git
cd mkdocs-translator
  1. 安装依赖:
pip install -r requirements.txt
  1. 设置环境变量:
export DIFY_API_KEY="your-dify-api-key"
  1. 运行翻译:
python -m mkdocs_translator.cli \
--source /path/to/source \
--target /path/to/target \
--target-language "英语" \
--api-key "your-dify-api-key" \
--user "your-username"

注意事项

  • 请确保目标目录存在,否则会创建一个新目录。
  • 请确保源目录存在,否则会报错。
  • 请确保 Dify AI API 密钥正确,否则会报错。
  • 请确保用户名正确,否则会报错。
  • 请确保查询语句正确,否则会报错。
  • 请确保响应模式正确,否则会报错。

About

mkdocs 文档的自动化翻译

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages