skills.rest
xixu-me
xixu-meCOMMUNITY
Explore all skills by this author →
Website𝕏@xixu_meGitHub

readme-i18n

Translate repository README files into localized README.<bcp47>.md variants.

71|7|Updated Mar 27, 2026
Search Tags:#documentation#markdown#github#localization#readme#i18n#language-selector
One-click install
npx skills add https://github.com/xixu-me/skills --skill readme-i18n-xixu-me
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-i18n
Source: https://github.com/xixu-me/skills/tree/main/skills/readme-i18n
Command: npx skills add https://github.com/xixu-me/skills --skill readme-i18n-xixu-me

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Help maintainers translate and synchronize a repository README into multiple languages without breaking Markdown structure, code examples, anchors, badges, or repo-specific tokens.

Core Features & Use Cases

  • Structure-preserving translation: Translate only human prose while preserving fenced code blocks, inline code spans, commands, flags, environment variables, URLs, file paths, and badge image sources.
  • Deterministic language selector updates: Insert or update a single language selector block near the top of each variant using canonical markers so future runs can safely modify the selector in place.
  • Anchor and link maintenance: Rewrite same-file anchor links to match localized heading slugs, preserve explicit anchor IDs, and verify that all intra-document links resolve.
  • Use Case: Add README.zh.md and README.es.md to a GitHub-style repo, wire a unified selector into every README variant, and ensure all internal links and badge URLs remain intact.

Quick Start

Translate README.md into Chinese and Spanish, produce README.zh.md and README.es.md, insert or update the canonical language selector in every file, and verify intra-document anchors.

Frequently Asked Questions about readme-i18n

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I localize a GitHub README file without breaking Markdown links and badges?▼

You can localize a GitHub README by translating prose while preserving fenced code blocks, inline code, URLs, and badge links. This approach creates translated sibling variants that maintain the exact structural integrity and functionality of the original document.

What is the best way to add a language selector to multiple README files?▼

The best way to add a language selector is by inserting a canonical selector block near the top of each README variant. This deterministic block uses standard markers so future translation runs can safely modify the selector in place across all files.

How do intra-document anchor links work when translating a README to another language?▼

When translating a README, intra-document anchor links are rewritten to match the localized heading slugs. The translation process preserves explicit anchor IDs and verifies that all same-file internal links correctly resolve in the new language variant.

Do I need to manually name translated README files for GitHub repositories?▼

You do not need to manually name translated README files because they are automatically produced following the README.<bcp47>.md convention, such as README.zh.md. This standardized naming ensures GitHub properly recognizes the localized sibling variants.

Can I translate a README while keeping code examples and environment variables intact?▼

Yes, you can translate a README while keeping code examples and environment variables intact by skipping fenced code blocks, inline code spans, commands, flags, and file paths during processing. Only the human-readable prose text is translated into the target language.

What are the limitations of using automated README localization for Markdown repositories?▼

A limitation of automated README localization is that it is designed specifically for GitHub-style repositories, meaning highly customized Markdown structures or non-standard badge configurations might not translate perfectly without manual verification of intra-document anchors.

Related Skills

Explore More Content & Communication Skills→
qmuqmu
1

translate

Translate English Markdown files while preserving formatting and frontmatter semantics.

Official
Basic
l395624064l395624064

readme-i18n

Translate repository READMEs into localized README.<bcp47>.md variants with a language selector.

Community
Intermediate
AustinZ21AustinZ21
4

speckit-taskstoissues

Convert dependency-ordered spec-kit tasks into GitHub issues.

Community
Intermediate
ericfitzericfitz
2

translate_to_language

Translate English text to a target language while preserving placeholders and formatting.

Community
Intermediate