SuperAPI AI Directory
Partner中文AI newsFavorites
Skillsmulti-lang-readme-cn

multi-lang-readme-cn

Writing & research

View repository

Updated 10-16 04:39

About this skill

Multi-Lang README (Chinese)

Overview

Translate an existing README into multilingual versions while keeping the Markdown structure, links, code blocks, and language-switching navigation stable. The workflow supports Chinese-English bilingual and multilingual README collections, and does not handle general document rewriting unrelated to READMEs.

When to Use

Use when the user requests the following:

  • Create a bilingual README (such as Chinese-English)
  • Create a multilingual README
  • Translate an existing README into a specified language
  • Unify the language-switching links in a README

Do Not Use

This skill should not be used in the following scenarios:

  • Translating general documents that are not READMEs
  • Content creation tasks unrelated to READMEs
  • Translation of high-risk documents such as legal/contract documents

Usage Instructions

  1. Locate the README source file to be translated (ask the user first if ambiguous).
  2. Confirm the target language and the primary README language strategy.
  3. Complete the translation while preserving the Markdown structure.
  4. Write to the target file according to the language suffix convention.
  5. Add language-switching links at the top of each language README.
  6. Check path, link, and format consistency before delivery.

Supported Languages

Code Language
en English
de German
ja Japanese
ko Korean
zh-CN Chinese

Workflow

Step 1: Locate the README

Find the README to be translated:

  • By default, check the root directory first README.md
  • If multiple READMEs exist, first have the user specify the target file

Step 2: Read the content

Read the full content, including:

  • Title and badges
  • Sections (Features, Installation, Usage, Contributing, License, etc.)
  • Code blocks
  • Links

Step 3: Confirm the target language

Ask the user for the target language. Default strategy:

  • README.md as the English primary version
  • If the current primary README is not in English, first convert it to an English primary version
  • Then generate other language versions as needed

If the user only says "make a bilingual README" without specifying languages, default to:

  • First generate English README.md
  • Then generate Chinese README.zh-CN.md

Step 4: Perform the translation

Translation requirements:

  • Preserve the Markdown structure
  • Do not translate code blocks
  • Translate titles and body text into the target language
  • Keep relative link paths unchanged
  • External link anchor text may be optimized for the target language

Step 5: Write to the target file

Recommended naming:

  • English:README.md
  • German:README.de.md
  • Japanese:README.ja.md
  • Korean:README.ko.md
  • Chinese:README.zh-CN.md

Step 6: Add language switching

Add language switching at the top of the README (after the title or badges), for example:

**English** | [中文](README.zh-CN.md) | [Deutsch](README.de.md) | [日本語](README.ja.md) | [한국어](README.ko.md)

Step 7: Update cross-links

Add links back to the primary document or multilingual cross-links in the translated files to avoid isolated documents.

Trigger Examples

  • "Help me create a Chinese-English README"
  • "Help me create a multilingual README"
  • "Translate the README into Japanese"
  • "Add README.zh-CN.md"
  • “create bilingual README”