readme-i18n

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

Updated Mar 27, 2026
One-click install
npx skills add https://github.com/l395624064/plantCard_Demo01 --skill readme-i18n-l395624064
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: readme-i18n
Source: https://github.com/l395624064/plantCard_Demo01/tree/main/.trae/skills/readme-i18n
Command: npx skills add https://github.com/l395624064/plantCard_Demo01 --skill readme-i18n-l395624064

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Localize a repository README without breaking the repo mechanics around it. It enables automatic generation of multilingual variants and a consistent language-switching experience.

Core Features & Use Cases

  • Translate the root README.md into localized variants such as README.zh.md and README.es.md while preserving GitHub-flavored Markdown structure and repo-specific tokens.
  • Update or add a shared language selector near the top of every localized variant to enable quick switching.
  • Support optional glossaries or do-not-translate lists and apply consistent translations across all targets.

Quick Start

Use the localization workflow to generate README variants by specifying the source README and a list of target languages.

Frequently Asked Questions about readme-i18n

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

FAQPage Schema
How do I translate a GitHub README into multiple language variants?

To translate a GitHub README into multiple language variants, the Skill generates localized files like README.zh.md and README.es.md while preserving GitHub-flavored Markdown structure and adding a language selector for quick switching.

How does a language selector work for multilingual README files?

A shared language selector is added or updated near the top of every localized README variant, enabling quick switching between translated files while preserving the original repo mechanics and anchors.

Can I preserve YAML frontmatter and Markdown anchors when localizing a README?

Yes, the localization process follows YAML frontmatter to define name and description, outputs README.<bcp47>.md variants, and preserves Markdown anchors and GitHub-flavored structure throughout the translated files.

What is the best way to maintain consistent terminology across multiple translated README files?

For consistent terminology across translated README files, you can apply optional glossaries or do-not-translate lists to enforce uniform translations across all target language variants.

Does this README localization approach break existing GitHub repository links?

No, it localizes the README without breaking repo mechanics, preserving GitHub-flavored Markdown structure and repo-specific tokens while creating the multilingual variants.