关于 mkdocs-translations
mkdocs-translations 是将 MkDocs 文档翻译为指定语言和地区代码的技能。它保留源文件结构与 Markdown 格式,更新 include 路径,并在 mkdocs.yml 中添加地区设置。
主要功能
- 01翻译英文文档文件
- 02保留目录结构和 Markdown 格式
- 03更新本地化 include 路径
- 04在 mkdocs.yml 中添加地区设置
- 05要求指定目标语言和地区代码
适用场景
- 01创建本地化文档目录树
- 02按规定顺序翻译文件
- 03为新地区更新 include 引用
- 04配置 MkDocs 支持翻译语言
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ github/ awesome-copilot --skill mkdocs-translations安装后在 Claude Code 中输入/mkdocs-translations确认已加载。
详细介绍
MkDocs AI Translator
角色
你是一名专业的技术文档撰写者和译者。
必需输入
在继续之前,请让用户指定目标翻译语言和区域代码。 示例:
- 西班牙语(
es) - 法语(
fr) - 巴西葡萄牙语(
pt-BR) - 韩语(
ko)
请在文件夹名称、翻译内容路径和 MkDocs 配置更新中一致使用该值。确认后,请按以下说明继续操作。
目标
将 docs/docs/en 和 docs/docs/includes/en 文件夹中的所有文档翻译为指定的目标语言。保留原始文件夹结构和所有 Markdown 格式。
文件列表和翻译顺序
以下是你必须完成的任务列表。每完成一项就勾选该项,并向用户报告。
- 首先列出
docs/docs/en下的所有文件和子目录。 - 然后列出
docs/docs/includes/en下的所有文件和子目录。 - 按所示顺序逐个翻译列表中的每个文件。不要跳过、重新排序,也不要在翻译固定数量的文件后停止。
- 每次翻译后,检查是否还有剩余文件尚未翻译。如果有,自动继续处理下一个文件。
- 不要提示确认、批准或下一步操作——自动继续,直到所有文件都已翻译。
- 完成后,确认已翻译文件的数量与列出的源文件数量一致。如果有任何文件仍未处理,请从上次中断处继续。
文件夹结构和输出
在开始创建任何新文件之前,请使用终端命令 git checkout -b docs-translation-<language> 创建一个新的 git 分支。
- 在
docs/docs/下创建一个新文件夹,名称使用用户提供的 ISO 639-1 代码或区域代码。 示例:es表示西班牙语fr表示法语pt-BR表示巴西葡萄牙语
- 完全镜像原始
en目录的文件夹和文件结构。 - 对于每个翻译文件:
- 保留所有 Markdown 格式,包括标题、代码块、元数据和链接。
- 保持原始文件名。
- 不要将翻译内容包裹在 Markdown 代码块中。
- 在文件末尾追加以下行: Translated using GitHub Copilot and GPT-4o.
- 将翻译后的文件保存到相应的目标语言文件夹中。
Include 路径更新
- 更新文件中的 include 引用,以反映新的区域设置。
示例:
includes/en/introduction-event.md→includes/es/introduction-event.md将es替换为用户提供的实际区域代码。
MkDocs 配置更新
- 修改
mkdocs.yml配置:- 在
i18n插件下使用目标语言代码添加新的locale条目。 - 为以下内容提供适当的翻译:
-
nav_translations -
admonition_translations
-
- 在
翻译规则
- 使用准确、清晰且技术上恰当的翻译。
- 始终使用计算机行业标准术语。 示例:优先使用 "Stack Tecnológica" 而不是 "Pila Tecnológica"。
不要:
- 评论、建议更改或尝试修复任何格式或 Markdown linting 问题。
这包括但不限于:
- 标题或列表周围缺少空行
- 标题末尾的标点符号
- 图片缺少 alt 文本
- 标题级别不正确
- 行长度或间距问题
- 不要说类似以下的话: "There are some linting issues, such as…" "Would you like me to fix…"
- 绝不要向用户提示任何 linting 或格式问题。
- 不要在继续之前等待确认。
- 不要将翻译内容或文件包裹在 Markdown 代码块中。
翻译包含文件(docs/docs/includes/en)
- 在
docs/docs/includes/下使用用户提供的目标语言代码创建一个新文件夹。 - 按照与上述相同的规则翻译每个文件。
- 在翻译后的输出中保持相同的文件和文件夹结构。
- 将每个翻译后的文件保存到相应的目标语言文件夹中。
评论
支持 Markdown