Back to Skills

readme-i18n

Use when the user wants to translate a repository README, make a repo multilingual, localize docs, add a language switcher, internationalize the README, or update localized README variants in a GitHub-style repository.

31stars1forksUpdated 4/9/2026

Security Assessment

Safe(100/100)
Security Score100/100

About readme-i18n

The readme-i18n skill helps users manage multilingual READMEs in GitHub-style repositories by automating the translation and localization process. This tool addresses the challenge of creating and maintaining multiple language versions of a repository's README file, ensuring the repository remains consistent and accessible to a global audience. By automating the translation of content, users can save time while avoiding the risk of introducing errors or inconsistencies when handling multiple language versions manually.

This skill is designed with a focus on preserving the structure of GitHub-flavored Markdown, ensuring that important elements such as code blocks, badges, and links are unaffected during the translation. It allows users to translate only human-language content while leaving technical elements such as project names, commands, and URLs intact. Additionally, it handles the creation of localized sibling files (e.g., README.zh.md) and updates language selectors in place, making it easier to manage and navigate different language versions.

Use cases for this skill include projects with international teams, open-source repositories requiring support for multiple languages, and any situation where a project needs to reach a broader audience. It is particularly useful for developers and project maintainers who want to localize their documentation without compromising the integrity of the code and repository structure.

FAQ

How do I specify the languages to translate the README into?

You can specify target languages directly in the request, or the skill will inspect the existing README for clues (such as language selectors or filenames) to infer the target languages. If these are unclear, it will ask for clarification.

Does this skill support translating technical content like code or commands?

No, the skill avoids translating technical content such as code blocks, inline code, shell commands, and environment variables to ensure that the code and configuration remain intact and functional.

Can I use this skill for other types of documentation or websites?

No, this skill is specifically designed for localizing GitHub-style README files. It is not intended for general website or app internationalization (i18n).

What happens if the repository already uses a different naming convention for multilingual README files?

If the repository uses a custom naming convention for README files, you can provide a filename override to maintain consistency with the existing structure.

All Files

3 files
SKILL.md7.6 KB
View
references/language-selector-reference.md1.9 KB
View
references/preservation-checklist.md2.6 KB
View

Install readme-i18n

Download and extract the skill files to your .claude/skills/ directory.

Quick Setup:

  1. Copy the skill folder to .claude/skills/
  2. Claude will automatically detect and use the skill

Repository

xixu-me/skills