关于 multi-lang-readme
用于将现有 README 翻译成多语言版本的 Skill,面向需要维护双语或多语言项目文档的团队。它保留 Markdown 结构、链接和代码块,并添加语言切换链接;不用于翻译 README 以外的文档。
主要功能
- 01翻译 README 至多种目标语言
- 02保留 Markdown 结构、链接和代码块
- 03按约定生成语言后缀文件
- 04添加或更新语言切换链接
- 05检查文件名、链接路径和格式
适用场景
- 01为项目创建中英双语 README
- 02将 README 翻译为日语或其他支持语言
- 03为多语言 README 添加互相导航链接
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ yangsonhung/ awesome-agent-skills --skill multi-lang-readme安装后在 Claude Code 中输入/multi-lang-readme确认已加载。
详细介绍
多语言 README
概述
通过翻译现有 README,同时保留 Markdown 结构、链接、代码块和语言切换导航,创建多语言 README 文件。此工作流支持创建双语和多语言 README 文件集,无需重写项目中无关的文档。
适用场景
用户提出以下需求时,使用此技能:
- 创建双语 README(例如,英语 + 中文)
- 生成多语言 README
- 将现有 README 翻译成一种或多种目标语言
- 在 README 文件之间添加统一的语言切换链接
不适用场景
以下情况不要使用此技能:
- 翻译非 README 的任意文档
- 重写产品需求或法律文档
- 与 README 翻译无关的内容生成任务
说明
- 找到要翻译的源 README 文件(如果不明确,请询问用户)。
- 确认目标语言和首选的规范 README 语言。
- 翻译内容,同时保留 Markdown、链接和代码块。
- 按照语言后缀约定写入翻译后的文件。
- 在每个 README 顶部添加或更新语言切换链接。
- 在最终输出前检查文件名、链接路径和格式。
支持的语言
| 代码 | 语言 |
|---|---|
| en | 英语 |
| de | 德语 |
| ja | 日语 |
| ko | 韩语 |
| zh-CN | 中文 |
工作流
第 1 步:查找 README
查找源 README:
- 检查根目录中的
README.md - 如果存在多个 README 文件,请询问要翻译哪个文件
第 2 步:读取 README 内容
读取完整的 Markdown 内容,包括:
- 标题
- 徽章
- 所有章节(功能、安装、用法、贡献、许可证等)
- 代码块
- 链接
第 3 步:确认目标语言
询问用户要翻译成哪种语言。默认假设:
- README.md 应始终使用英语,作为规范版本
- 如果当前 README 使用中文(或任何非英语语言),请先将其翻译成英语
- 确定英语版本后,再按要求添加其他语言版本
如果用户提出“创建双语 README”但未指定语言:
- 先将现有 README 翻译成英语(替换或创建 README.md)
- 然后添加中文版(README.zh-CN.md)
第 4 步:使用 AI 翻译
遵循以下规则进行翻译:
- 保留 Markdown 格式
- 代码块保持不变
- 将章节标题翻译成目标语言
- 保留内部链接(相对路径)不变
- 对于外部链接,可酌情将锚文本翻译成目标语言
第 5 步:创建翻译后的 README
重要:除非用户明确要求采用其他约定,否则将 README.md 保留为规范英语版本。
- 英语:README.md(创建或替换为英语版本)
- 德语:README.de.md
- 日语:README.ja.md
- 韩语:README.ko.md
- 中文:README.zh-CN.md
如果原始 README 使用非英语,且用户同意,请将其替换为英语版 README.md。
第 6 步:添加语言切换器
更新原始 README,在顶部加入语言切换器:
**English** | [中文](README.zh-CN.md) | [Deutsch](README.de.md) | [日本語](README.ja.md) | [한국어](README.ko.md)
将其添加到标题或徽章下方、正文内容之前。
第 7 步:更新翻译后的 README
在翻译后的 README 中添加对应的反向链接:
**[Original](README.md)** | [中文](README.zh-CN.md)
语言代码参考
en → no suffix (README.md)
de → README.de.md
ja → README.ja.md
ko → README.ko.md
zh-CN → README.zh-CN.md
常见触发词
- “创建双语 README”
- “创建英语和中文 README”
- “将 README 翻译成日语”
- “添加德语版 README”
- “添加 README.zh-CN.md”
评论
支持 Markdown