| name | add-lang |
| description | 自动新增文档语言信息 |
根据中文文档(zh-cn/)镜像生成目标语言文档,自动完成翻译。
触发方式
用户指定目标语言,如 /add-lang 日语、/add-lang ko-kr。支持语言名或 locale 代码。
核心规则
- 以中文为源 — 读取
docs/docs/zh-cn/ 下所有 .md 文件作为翻译源
- 完整镜像 — 目标语言目录下的文件与
zh-cn/ 一一对应,路径结构完全一致
- 翻译不翻译代码标识符 — 类名、方法名、NuGet 包名、命名空间、程序集名称保持原文;代码注释、文档正文、侧边栏显示名需要翻译
- 链接路径更新 — 所有内部链接(
/docs/zh-cn/...)替换为目标语言路径(/docs/{locale}/...)
- Docsify 语法保留 —
!>、?>、```C# 等语法标记不翻译、不修改
locale 代码
| 语言 | locale |
|---|
| 英语 | en-us |
| 日语 | ja-jp |
| 韩语 | ko-kr |
| 繁体中文 | zh-tw |
| 法语 | fr-fr |
| 德语 | de-de |
| 西班牙语 | es-es |
| 葡萄牙语 | pt-pt |
用户直接给 locale 代码(如 ko-kr)则直接使用;给语言名(如 韩语)则按上表映射。上表未覆盖的语言,自行推导标准 locale 代码。
操作流程
- 确认目标 locale 代码,检查
docs/docs/{locale}/ 是否已存在
- 读取
docs/docs/zh-cn/ 下所有 .md 文件
- 在
docs/docs/{locale}/ 下创建镜像目录结构
- 逐个翻译文件:
- 翻译正文和注释 — 文档正文、代码注释、侧边栏显示名翻译为目标语言
- 保留标识符 — 类名、方法名、程序集名称、NuGet 包名、命名空间原文保留
- 替换链接 —
/docs/zh-cn/ → /docs/{locale}/
- 保留语法 —
!> ?> ```C# 等标记原样保留
- 更新
docs/docs/{locale}/_sidebar.md:分组名和显示名翻译为目标语言,链接路径更新
- 校验:文件数量与
zh-cn/ 一致、所有内部链接已更新为 /{locale}/、标识符未被翻译
侧边栏翻译
侧边栏分组名和显示名需要翻译为目标语言。以日语为例:
- はじめに
- [クイックスタート](/docs/ja-jp/quickstart.md)
- [構成のおすすめ](/docs/ja-jp/recommended.md)
- コアコンポーネント
- [Config コンポーネント](/docs/ja-jp/components/ConfigSdk.md)
...
分组顺序保持不变:入门 → 核心组件 → 基础组件 → 应用组件。